| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.GtkSource.Objects.CompletionCell
Description
Widget for single cell of completion proposal.
The GtkSourceCompletionCell widget provides a container to display various
types of information with the completion display.
Each proposal may consist of multiple cells depending on the complexity of the proposal. For example, programming language proposals may contain a cell for the "left-hand-side" of an operation along with the "typed-text" for a function name and "parameters". They may also optionally set an icon to signify the kind of result.
A [ifacecompletionProvider] should implement the
[vfunccompletionProvider.display] virtual function to control
how to convert data from their [ifacecompletionProposal] to content for
the GtkSourceCompletionCell.
Synopsis
- newtype CompletionCell = CompletionCell (ManagedPtr CompletionCell)
- class (GObject o, IsDescendantOf CompletionCell o) => IsCompletionCell o
- toCompletionCell :: (MonadIO m, IsCompletionCell o) => o -> m CompletionCell
- completionCellGetColumn :: (HasCallStack, MonadIO m, IsCompletionCell a) => a -> m CompletionColumn
- completionCellGetWidget :: (HasCallStack, MonadIO m, IsCompletionCell a) => a -> m (Maybe Widget)
- completionCellSetGicon :: (HasCallStack, MonadIO m, IsCompletionCell a, IsIcon b) => a -> b -> m ()
- completionCellSetIconName :: (HasCallStack, MonadIO m, IsCompletionCell a) => a -> Text -> m ()
- completionCellSetMarkup :: (HasCallStack, MonadIO m, IsCompletionCell a) => a -> Text -> m ()
- completionCellSetPaintable :: (HasCallStack, MonadIO m, IsCompletionCell a, IsPaintable b) => a -> b -> m ()
- completionCellSetText :: (HasCallStack, MonadIO m, IsCompletionCell a) => a -> Maybe Text -> m ()
- completionCellSetTextWithAttributes :: (HasCallStack, MonadIO m, IsCompletionCell a) => a -> Text -> AttrList -> m ()
- completionCellSetWidget :: (HasCallStack, MonadIO m, IsCompletionCell a, IsWidget b) => a -> b -> m ()
- constructCompletionCellColumn :: (IsCompletionCell o, MonadIO m) => CompletionColumn -> m (GValueConstruct o)
- getCompletionCellColumn :: (MonadIO m, IsCompletionCell o) => o -> m CompletionColumn
- constructCompletionCellMarkup :: (IsCompletionCell o, MonadIO m) => Text -> m (GValueConstruct o)
- getCompletionCellMarkup :: (MonadIO m, IsCompletionCell o) => o -> m (Maybe Text)
- setCompletionCellMarkup :: (MonadIO m, IsCompletionCell o) => o -> Text -> m ()
- constructCompletionCellPaintable :: (IsCompletionCell o, MonadIO m, IsPaintable a) => a -> m (GValueConstruct o)
- getCompletionCellPaintable :: (MonadIO m, IsCompletionCell o) => o -> m (Maybe Paintable)
- setCompletionCellPaintable :: (MonadIO m, IsCompletionCell o, IsPaintable a) => o -> a -> m ()
- clearCompletionCellText :: (MonadIO m, IsCompletionCell o) => o -> m ()
- constructCompletionCellText :: (IsCompletionCell o, MonadIO m) => Text -> m (GValueConstruct o)
- getCompletionCellText :: (MonadIO m, IsCompletionCell o) => o -> m (Maybe Text)
- setCompletionCellText :: (MonadIO m, IsCompletionCell o) => o -> Text -> m ()
- constructCompletionCellWidget :: (IsCompletionCell o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
- getCompletionCellWidget :: (MonadIO m, IsCompletionCell o) => o -> m (Maybe Widget)
- setCompletionCellWidget :: (MonadIO m, IsCompletionCell o, IsWidget a) => o -> a -> m ()
Exported types
newtype CompletionCell Source #
Memory-managed wrapper type.
Constructors
| CompletionCell (ManagedPtr CompletionCell) |
Instances
class (GObject o, IsDescendantOf CompletionCell o) => IsCompletionCell o Source #
Type class for types which can be safely cast to CompletionCell, for instance with toCompletionCell.
Instances
| (GObject o, IsDescendantOf CompletionCell o) => IsCompletionCell o Source # | |
Defined in GI.GtkSource.Objects.CompletionCell | |
toCompletionCell :: (MonadIO m, IsCompletionCell o) => o -> m CompletionCell Source #
Cast to CompletionCell, for types for which this is known to be safe. For general casts, use castTo.
Methods
Click to display all available methods, including inherited ones
Methods
actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.
Getters
getAccessibleParent, getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAtContext, getBounds, getBuildableId, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getColumn, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getFirstAccessibleChild, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPlatformState, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidget, getWidth.
Setters
setAccessibleParent, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setGicon, setHalign, setHasTooltip, setHexpand, setHexpandSet, setIconName, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setMarkup, setName, setOpacity, setOverflow, setPaintable, setParent, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setText, setTextWithAttributes, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, setWidget.
getColumn
completionCellGetColumn :: (HasCallStack, MonadIO m, IsCompletionCell a) => a -> m CompletionColumn Source #
No description available in the introspection data.
getWidget
completionCellGetWidget Source #
Arguments
| :: (HasCallStack, MonadIO m, IsCompletionCell a) | |
| => a |
|
| -> m (Maybe Widget) |
Gets the child Widget, if any.
setGicon
completionCellSetGicon :: (HasCallStack, MonadIO m, IsCompletionCell a, IsIcon b) => a -> b -> m () Source #
No description available in the introspection data.
setIconName
completionCellSetIconName :: (HasCallStack, MonadIO m, IsCompletionCell a) => a -> Text -> m () Source #
No description available in the introspection data.
setMarkup
completionCellSetMarkup :: (HasCallStack, MonadIO m, IsCompletionCell a) => a -> Text -> m () Source #
No description available in the introspection data.
setPaintable
completionCellSetPaintable :: (HasCallStack, MonadIO m, IsCompletionCell a, IsPaintable b) => a -> b -> m () Source #
No description available in the introspection data.
setText
completionCellSetText Source #
Arguments
| :: (HasCallStack, MonadIO m, IsCompletionCell a) | |
| => a |
|
| -> Maybe Text |
|
| -> m () |
Sets the text for the column cell. Use Nothing to unset.
setTextWithAttributes
completionCellSetTextWithAttributes :: (HasCallStack, MonadIO m, IsCompletionCell a) => a -> Text -> AttrList -> m () Source #
No description available in the introspection data.
setWidget
completionCellSetWidget :: (HasCallStack, MonadIO m, IsCompletionCell a, IsWidget b) => a -> b -> m () Source #
No description available in the introspection data.
Properties
column
No description available in the introspection data.
constructCompletionCellColumn :: (IsCompletionCell o, MonadIO m) => CompletionColumn -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “column” property. This is rarely needed directly, but it is used by new.
getCompletionCellColumn :: (MonadIO m, IsCompletionCell o) => o -> m CompletionColumn Source #
Get the value of the “column” property.
When overloading is enabled, this is equivalent to
get completionCell #column
markup
No description available in the introspection data.
constructCompletionCellMarkup :: (IsCompletionCell o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “markup” property. This is rarely needed directly, but it is used by new.
getCompletionCellMarkup :: (MonadIO m, IsCompletionCell o) => o -> m (Maybe Text) Source #
Get the value of the “markup” property.
When overloading is enabled, this is equivalent to
get completionCell #markup
setCompletionCellMarkup :: (MonadIO m, IsCompletionCell o) => o -> Text -> m () Source #
Set the value of the “markup” property.
When overloading is enabled, this is equivalent to
setcompletionCell [ #markup:=value ]
paintable
No description available in the introspection data.
constructCompletionCellPaintable :: (IsCompletionCell o, MonadIO m, IsPaintable a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “paintable” property. This is rarely needed directly, but it is used by new.
getCompletionCellPaintable :: (MonadIO m, IsCompletionCell o) => o -> m (Maybe Paintable) Source #
Get the value of the “paintable” property.
When overloading is enabled, this is equivalent to
get completionCell #paintable
setCompletionCellPaintable :: (MonadIO m, IsCompletionCell o, IsPaintable a) => o -> a -> m () Source #
Set the value of the “paintable” property.
When overloading is enabled, this is equivalent to
setcompletionCell [ #paintable:=value ]
text
No description available in the introspection data.
clearCompletionCellText :: (MonadIO m, IsCompletionCell o) => o -> m () Source #
Set the value of the “text” property to Nothing.
When overloading is enabled, this is equivalent to
clear #text
constructCompletionCellText :: (IsCompletionCell o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “text” property. This is rarely needed directly, but it is used by new.
getCompletionCellText :: (MonadIO m, IsCompletionCell o) => o -> m (Maybe Text) Source #
Get the value of the “text” property.
When overloading is enabled, this is equivalent to
get completionCell #text
setCompletionCellText :: (MonadIO m, IsCompletionCell o) => o -> Text -> m () Source #
Set the value of the “text” property.
When overloading is enabled, this is equivalent to
setcompletionCell [ #text:=value ]
widget
No description available in the introspection data.
constructCompletionCellWidget :: (IsCompletionCell o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “widget” property. This is rarely needed directly, but it is used by new.
getCompletionCellWidget :: (MonadIO m, IsCompletionCell o) => o -> m (Maybe Widget) Source #
Get the value of the “widget” property.
When overloading is enabled, this is equivalent to
get completionCell #widget
setCompletionCellWidget :: (MonadIO m, IsCompletionCell o, IsWidget a) => o -> a -> m () Source #
Set the value of the “widget” property.
When overloading is enabled, this is equivalent to
setcompletionCell [ #widget:=value ]