GI.GtkSource.Objects.CompletionItem

No description available in the introspection data.

Exported types

newtype CompletionItem

Memory-managed wrapper type.

Constructors

CompletionItem (ManagedPtr CompletionItem)

Instances

GObject CompletionItem

Defined in GI.GtkSource.Objects.CompletionItem

Methods

gobjectType :: CompletionItem -> IO GType

IsObject CompletionItem

Defined in GI.GtkSource.Objects.CompletionItem

IsCompletionProposal CompletionItem

Defined in GI.GtkSource.Objects.CompletionItem

IsCompletionItem CompletionItem

Defined in GI.GtkSource.Objects.CompletionItem

class GObject o => IsCompletionItem o

Type class for types which can be safely cast to CompletionItem, for instance with toCompletionItem.

Instances

(GObject a, (UnknownAncestorError CompletionItem a :: Constraint)) => IsCompletionItem a

Defined in GI.GtkSource.Objects.CompletionItem

IsCompletionItem CompletionItem

Defined in GI.GtkSource.Objects.CompletionItem

toCompletionItem :: (MonadIO m, IsCompletionItem o) => o -> m CompletionItem

Cast to CompletionItem, for types for which this is known to be safe. For general casts, use castTo.

noCompletionItem :: Maybe CompletionItem

A convenience alias for Nothing :: Maybe CompletionItem.

Methods

new

completionItemNew

Arguments

:: (HasCallStack, MonadIO m, IsPixbuf a)

=> Text

label: The item label.

-> Text

text: The item text.

-> Maybe a

icon: The item icon.

-> Maybe Text

info: The item extra information.

-> m CompletionItem

Returns: a new CompletionItem.

Deprecated: (Since version 3.24)Use completionItemNew2 instead.

Create a new CompletionItem with label label, icon icon and extra information info. Both icon and info can be Nothing in which case there will be no icon shown and no extra information available.

new2

completionItemNew2

Arguments

:: (HasCallStack, MonadIO m)

=> m CompletionItem

Returns: a new CompletionItem.

Creates a new CompletionItem. The desired properties need to be set afterwards.

Since: 3.24

newFromStock

completionItemNewFromStock

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Text

label: The item label.

-> Text

text: The item text.

-> Text

stock: The stock icon.

-> Maybe Text

info: The item extra information.

-> m CompletionItem

Returns: a new CompletionItem.

Deprecated: (Since version 3.10)Use completionItemNew2 instead.

Creates a new CompletionItem from a stock item. If label is Nothing, the stock label will be used.

newWithMarkup

completionItemNewWithMarkup

Arguments

:: (HasCallStack, MonadIO m, IsPixbuf a)

=> Text

markup: The item markup label.

-> Text

text: The item text.

-> Maybe a

icon: The item icon.

-> Maybe Text

info: The item extra information.

-> m CompletionItem

Returns: a new CompletionItem.

Deprecated: (Since version 3.24)Use completionItemNew2 instead.

Create a new CompletionItem with markup label markup, icon icon and extra information info. Both icon and info can be Nothing in which case there will be no icon shown and no extra information available.

setGicon

completionItemSetGicon

Arguments

:: (HasCallStack, MonadIO m, IsCompletionItem a, IsIcon b)

=> a

item: a CompletionItem.

-> Maybe b

gicon: the Icon, or Nothing.

-> m ()

No description available in the introspection data.

Since: 3.24

setIcon

completionItemSetIcon

Arguments

:: (HasCallStack, MonadIO m, IsCompletionItem a, IsPixbuf b)

=> a

item: a CompletionItem.

-> Maybe b

icon: the Pixbuf, or Nothing.

-> m ()

No description available in the introspection data.

Since: 3.24

setIconName

completionItemSetIconName

Arguments

:: (HasCallStack, MonadIO m, IsCompletionItem a)

=> a

item: a CompletionItem.

-> Maybe Text

iconName: the icon name, or Nothing.

-> m ()

No description available in the introspection data.

Since: 3.24

setInfo

completionItemSetInfo

Arguments

:: (HasCallStack, MonadIO m, IsCompletionItem a)

=> a

item: a CompletionItem.

-> Maybe Text

info: the info, or Nothing.

-> m ()

No description available in the introspection data.

Since: 3.24

setLabel

completionItemSetLabel

Arguments

:: (HasCallStack, MonadIO m, IsCompletionItem a)

=> a

item: a CompletionItem.

-> Maybe Text

label: the label, or Nothing.

-> m ()

No description available in the introspection data.

Since: 3.24

setMarkup

completionItemSetMarkup

Arguments

:: (HasCallStack, MonadIO m, IsCompletionItem a)

=> a

item: a CompletionItem.

-> Maybe Text

markup: the markup, or Nothing.

-> m ()

No description available in the introspection data.

Since: 3.24

setText

completionItemSetText

Arguments

:: (HasCallStack, MonadIO m, IsCompletionItem a)

=> a

item: a CompletionItem.

-> Maybe Text

text: the text, or Nothing.

-> m ()

No description available in the introspection data.

Since: 3.24

Properties

gicon

The Icon for the icon to be shown for this proposal.

Since: 3.18

clearCompletionItemGicon :: (MonadIO m, IsCompletionItem o) => o -> m ()

Set the value of the “gicon” property to Nothing. When overloading is enabled, this is equivalent to

clear #gicon

constructCompletionItemGicon :: (IsCompletionItem o, IsIcon a) => a -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “gicon” property. This is rarely needed directly, but it is used by new.

getCompletionItemGicon :: (MonadIO m, IsCompletionItem o) => o -> m (Maybe Icon)

Get the value of the “gicon” property. When overloading is enabled, this is equivalent to

get completionItem #gicon

setCompletionItemGicon :: (MonadIO m, IsCompletionItem o, IsIcon a) => o -> a -> m ()

Set the value of the “gicon” property. When overloading is enabled, this is equivalent to

set completionItem [ #gicon := value ]

icon

The Pixbuf for the icon to be shown for this proposal.

clearCompletionItemIcon :: (MonadIO m, IsCompletionItem o) => o -> m ()

Set the value of the “icon” property to Nothing. When overloading is enabled, this is equivalent to

clear #icon

constructCompletionItemIcon :: (IsCompletionItem o, IsPixbuf a) => a -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “icon” property. This is rarely needed directly, but it is used by new.

getCompletionItemIcon :: (MonadIO m, IsCompletionItem o) => o -> m (Maybe Pixbuf)

Get the value of the “icon” property. When overloading is enabled, this is equivalent to

get completionItem #icon

setCompletionItemIcon :: (MonadIO m, IsCompletionItem o, IsPixbuf a) => o -> a -> m ()

Set the value of the “icon” property. When overloading is enabled, this is equivalent to

set completionItem [ #icon := value ]

iconName

The icon name for the icon to be shown for this proposal.

Since: 3.18

clearCompletionItemIconName :: (MonadIO m, IsCompletionItem o) => o -> m ()

Set the value of the “icon-name” property to Nothing. When overloading is enabled, this is equivalent to

clear #iconName

constructCompletionItemIconName :: IsCompletionItem o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “icon-name” property. This is rarely needed directly, but it is used by new.

getCompletionItemIconName :: (MonadIO m, IsCompletionItem o) => o -> m (Maybe Text)

Get the value of the “icon-name” property. When overloading is enabled, this is equivalent to

get completionItem #iconName

setCompletionItemIconName :: (MonadIO m, IsCompletionItem o) => o -> Text -> m ()

Set the value of the “icon-name” property. When overloading is enabled, this is equivalent to

set completionItem [ #iconName := value ]

info

Optional extra information to be shown for this proposal.

clearCompletionItemInfo :: (MonadIO m, IsCompletionItem o) => o -> m ()

Set the value of the “info” property to Nothing. When overloading is enabled, this is equivalent to

clear #info

constructCompletionItemInfo :: IsCompletionItem o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “info” property. This is rarely needed directly, but it is used by new.

getCompletionItemInfo :: (MonadIO m, IsCompletionItem o) => o -> m (Maybe Text)

Get the value of the “info” property. When overloading is enabled, this is equivalent to

get completionItem #info

setCompletionItemInfo :: (MonadIO m, IsCompletionItem o) => o -> Text -> m ()

Set the value of the “info” property. When overloading is enabled, this is equivalent to

set completionItem [ #info := value ]

label

Label to be shown for this proposal.

clearCompletionItemLabel :: (MonadIO m, IsCompletionItem o) => o -> m ()

Set the value of the “label” property to Nothing. When overloading is enabled, this is equivalent to

clear #label

constructCompletionItemLabel :: IsCompletionItem o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “label” property. This is rarely needed directly, but it is used by new.

getCompletionItemLabel :: (MonadIO m, IsCompletionItem o) => o -> m (Maybe Text)

Get the value of the “label” property. When overloading is enabled, this is equivalent to

get completionItem #label

setCompletionItemLabel :: (MonadIO m, IsCompletionItem o) => o -> Text -> m ()

Set the value of the “label” property. When overloading is enabled, this is equivalent to

set completionItem [ #label := value ]

markup

Label with markup to be shown for this proposal.

clearCompletionItemMarkup :: (MonadIO m, IsCompletionItem o) => o -> m ()

Set the value of the “markup” property to Nothing. When overloading is enabled, this is equivalent to

clear #markup

constructCompletionItemMarkup :: IsCompletionItem o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “markup” property. This is rarely needed directly, but it is used by new.

getCompletionItemMarkup :: (MonadIO m, IsCompletionItem o) => o -> m (Maybe Text)

Get the value of the “markup” property. When overloading is enabled, this is equivalent to

get completionItem #markup

setCompletionItemMarkup :: (MonadIO m, IsCompletionItem o) => o -> Text -> m ()

Set the value of the “markup” property. When overloading is enabled, this is equivalent to

set completionItem [ #markup := value ]

text

Proposal text.

clearCompletionItemText :: (MonadIO m, IsCompletionItem o) => o -> m ()

Set the value of the “text” property to Nothing. When overloading is enabled, this is equivalent to

clear #text

constructCompletionItemText :: IsCompletionItem o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “text” property. This is rarely needed directly, but it is used by new.

getCompletionItemText :: (MonadIO m, IsCompletionItem o) => o -> m (Maybe Text)

Get the value of the “text” property. When overloading is enabled, this is equivalent to

get completionItem #text

setCompletionItemText :: (MonadIO m, IsCompletionItem o) => o -> Text -> m ()

Set the value of the “text” property. When overloading is enabled, this is equivalent to

set completionItem [ #text := value ]