Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
An IBusLookuptable stores the candidate words or phrases for users to choose from.
Use engineUpdateLookupTable
, engineShowLookupTable
,
and engineHideLookupTable
to update, show and hide the lookup
table.
see_also: Engine
Synopsis
- newtype LookupTable = LookupTable (ManagedPtr LookupTable)
- class (GObject o, IsDescendantOf LookupTable o) => IsLookupTable o
- toLookupTable :: (MonadIO m, IsLookupTable o) => o -> m LookupTable
- lookupTableAppendCandidate :: (HasCallStack, MonadIO m, IsLookupTable a, IsText b) => a -> b -> m ()
- lookupTableAppendLabel :: (HasCallStack, MonadIO m, IsLookupTable a, IsText b) => a -> b -> m ()
- lookupTableClear :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> m ()
- lookupTableCursorDown :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> m Bool
- lookupTableCursorUp :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> m Bool
- lookupTableGetCandidate :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> Word32 -> m Text
- lookupTableGetCursorInPage :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> m Word32
- lookupTableGetCursorPos :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> m Word32
- lookupTableGetLabel :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> Word32 -> m Text
- lookupTableGetNumberOfCandidates :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> m Word32
- lookupTableGetOrientation :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> m Int32
- lookupTableGetPageSize :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> m Word32
- lookupTableIsCursorVisible :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> m Bool
- lookupTableIsRound :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> m Bool
- lookupTableNew :: (HasCallStack, MonadIO m) => Word32 -> Word32 -> Bool -> Bool -> m LookupTable
- lookupTablePageDown :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> m Bool
- lookupTablePageUp :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> m Bool
- lookupTableSetCursorPos :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> Word32 -> m ()
- lookupTableSetCursorVisible :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> Bool -> m ()
- lookupTableSetLabel :: (HasCallStack, MonadIO m, IsLookupTable a, IsText b) => a -> Word32 -> b -> m ()
- lookupTableSetOrientation :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> Int32 -> m ()
- lookupTableSetPageSize :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> Word32 -> m ()
- lookupTableSetRound :: (HasCallStack, MonadIO m, IsLookupTable a) => a -> Bool -> m ()
Exported types
newtype LookupTable Source #
Memory-managed wrapper type.
Instances
Eq LookupTable Source # | |
Defined in GI.IBus.Objects.LookupTable (==) :: LookupTable -> LookupTable -> Bool # (/=) :: LookupTable -> LookupTable -> Bool # | |
IsGValue LookupTable Source # | Convert |
Defined in GI.IBus.Objects.LookupTable toGValue :: LookupTable -> IO GValue # fromGValue :: GValue -> IO LookupTable # | |
GObject LookupTable Source # | |
Defined in GI.IBus.Objects.LookupTable gobjectType :: IO GType # | |
HasParentTypes LookupTable Source # | |
Defined in GI.IBus.Objects.LookupTable | |
type ParentTypes LookupTable Source # | |
Defined in GI.IBus.Objects.LookupTable |
class (GObject o, IsDescendantOf LookupTable o) => IsLookupTable o Source #
Type class for types which can be safely cast to LookupTable
, for instance with toLookupTable
.
Instances
(GObject o, IsDescendantOf LookupTable o) => IsLookupTable o Source # | |
Defined in GI.IBus.Objects.LookupTable |
toLookupTable :: (MonadIO m, IsLookupTable o) => o -> m LookupTable Source #
Cast to LookupTable
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Overloaded methods
appendCandidate
lookupTableAppendCandidate Source #
:: (HasCallStack, MonadIO m, IsLookupTable a, IsText b) | |
=> a |
|
-> b |
|
-> m () |
Append a candidate word/phrase to IBusLookupTable, and increase reference.
appendLabel
lookupTableAppendLabel Source #
:: (HasCallStack, MonadIO m, IsLookupTable a, IsText b) | |
=> a |
|
-> b |
|
-> m () |
Append a candidate word/phrase to IBusLookupTable, and increase reference. This function is needed if the input method select candidate with non-numeric keys such as "asdfghjkl;".
clear
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> m () |
Clear and remove all candidate from an IBusLookupTable.
cursorDown
lookupTableCursorDown Source #
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> m Bool | Returns: |
Go to next candidate of an LookupTable
.
It returns FALSE if it is already at the last candidate, unless <code>table>-round==TRUE</code>, where it will go to the first candidate.
cursorUp
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> m Bool | Returns: |
Go to previous candidate of an LookupTable
.
It returns FALSE if it is already at the first candidate, unless <code>table>-round==TRUE</code>, where it will go to the last candidate.
getCandidate
lookupTableGetCandidate Source #
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> Word32 |
|
-> m Text | Returns: IBusText at the given index; NULL if no such
|
Return Text
at the given index. Borrowed reference.
getCursorInPage
lookupTableGetCursorInPage Source #
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> m Word32 | Returns: The position of cursor in current page. |
Gets the cursor position in current page of LookupTable
.
getCursorPos
lookupTableGetCursorPos Source #
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> m Word32 | Returns: The position of cursor. |
Gets the cursor position of LookupTable
.
getLabel
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> Word32 |
|
-> m Text |
Return Text
at the given index. Borrowed reference.
getNumberOfCandidates
lookupTableGetNumberOfCandidates Source #
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> m Word32 | Returns: The number of candidates in the table |
Return the number of candidate in the table.
getOrientation
lookupTableGetOrientation Source #
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> m Int32 | Returns: The orientation of the |
Returns the orientation of the LookupTable
.
getPageSize
lookupTableGetPageSize Source #
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> m Word32 | Returns: Page size, i.e., number of candidate shown per page. dd |
Gets the number of candidate shown per page.
isCursorVisible
lookupTableIsCursorVisible Source #
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> m Bool | Returns: Whether the cursor of |
Returns whether the cursor of an LookupTable
is visible.
isRound
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> m Bool | Returns: Whether the |
Returns whether the LookupTable
is round.
new
:: (HasCallStack, MonadIO m) | |
=> Word32 |
|
-> Word32 |
|
-> Bool |
|
-> Bool |
|
-> m LookupTable | Returns: A newly allocated |
Craetes a new LookupTable
.
pageDown
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> m Bool | Returns: |
Go to next page of an LookupTable
.
It returns FALSE if it is already at the last page, unless <code>table>-round==TRUE</code>, where it will go to the first page.
pageUp
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> m Bool | Returns: |
Go to previous page of an LookupTable
.
It returns FALSE if it is already at the first page, unless <code>table>-round==TRUE</code>, where it will go to the last page.
setCursorPos
lookupTableSetCursorPos Source #
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> Word32 |
|
-> m () |
Set the cursor position of IBusLookupTable.
setCursorVisible
lookupTableSetCursorVisible Source #
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> Bool |
|
-> m () |
Set whether to make the cursor of an IBusLookupTable visible or not.
setLabel
:: (HasCallStack, MonadIO m, IsLookupTable a, IsText b) | |
=> a |
|
-> Word32 |
|
-> b |
|
-> m () |
Append a candidate word/phrase to IBusLookupTable, and increase reference. This function is needed if the input method select candidate with non-numeric keys such as "asdfghjkl;".
setOrientation
lookupTableSetOrientation Source #
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> Int32 |
|
-> m () |
Set the orientation.
setPageSize
lookupTableSetPageSize Source #
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> Word32 |
|
-> m () |
Set the number of candidate shown per page.
setRound
:: (HasCallStack, MonadIO m, IsLookupTable a) | |
=> a |
|
-> Bool |
|
-> m () |
Set whether to make the IBusLookupTable round or not.