Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
Safe Haskell | None |
Language | Haskell2010 |
No description available in the introspection data.
Synopsis
- newtype CompletionItem = CompletionItem (ManagedPtr CompletionItem)
- class (GObject o, IsDescendantOf CompletionItem o) => IsCompletionItem o
- toCompletionItem :: (MonadIO m, IsCompletionItem o) => o -> m CompletionItem
- noCompletionItem :: Maybe CompletionItem
- completionItemNew :: (HasCallStack, MonadIO m, IsPixbuf a) => Text -> Text -> Maybe a -> Maybe Text -> m CompletionItem
- completionItemNew2 :: (HasCallStack, MonadIO m) => m CompletionItem
- completionItemNewFromStock :: (HasCallStack, MonadIO m) => Maybe Text -> Text -> Text -> Maybe Text -> m CompletionItem
- completionItemNewWithMarkup :: (HasCallStack, MonadIO m, IsPixbuf a) => Text -> Text -> Maybe a -> Maybe Text -> m CompletionItem
- completionItemSetGicon :: (HasCallStack, MonadIO m, IsCompletionItem a, IsIcon b) => a -> Maybe b -> m ()
- completionItemSetIcon :: (HasCallStack, MonadIO m, IsCompletionItem a, IsPixbuf b) => a -> Maybe b -> m ()
- completionItemSetIconName :: (HasCallStack, MonadIO m, IsCompletionItem a) => a -> Maybe Text -> m ()
- completionItemSetInfo :: (HasCallStack, MonadIO m, IsCompletionItem a) => a -> Maybe Text -> m ()
- completionItemSetLabel :: (HasCallStack, MonadIO m, IsCompletionItem a) => a -> Maybe Text -> m ()
- completionItemSetMarkup :: (HasCallStack, MonadIO m, IsCompletionItem a) => a -> Maybe Text -> m ()
- completionItemSetText :: (HasCallStack, MonadIO m, IsCompletionItem a) => a -> Maybe Text -> m ()
- clearCompletionItemGicon :: (MonadIO m, IsCompletionItem o) => o -> m ()
- constructCompletionItemGicon :: (IsCompletionItem o, IsIcon a) => a -> IO (GValueConstruct o)
- getCompletionItemGicon :: (MonadIO m, IsCompletionItem o) => o -> m (Maybe Icon)
- setCompletionItemGicon :: (MonadIO m, IsCompletionItem o, IsIcon a) => o -> a -> m ()
- clearCompletionItemIcon :: (MonadIO m, IsCompletionItem o) => o -> m ()
- constructCompletionItemIcon :: (IsCompletionItem o, IsPixbuf a) => a -> IO (GValueConstruct o)
- getCompletionItemIcon :: (MonadIO m, IsCompletionItem o) => o -> m (Maybe Pixbuf)
- setCompletionItemIcon :: (MonadIO m, IsCompletionItem o, IsPixbuf a) => o -> a -> m ()
- clearCompletionItemIconName :: (MonadIO m, IsCompletionItem o) => o -> m ()
- constructCompletionItemIconName :: IsCompletionItem o => Text -> IO (GValueConstruct o)
- getCompletionItemIconName :: (MonadIO m, IsCompletionItem o) => o -> m (Maybe Text)
- setCompletionItemIconName :: (MonadIO m, IsCompletionItem o) => o -> Text -> m ()
- clearCompletionItemInfo :: (MonadIO m, IsCompletionItem o) => o -> m ()
- constructCompletionItemInfo :: IsCompletionItem o => Text -> IO (GValueConstruct o)
- getCompletionItemInfo :: (MonadIO m, IsCompletionItem o) => o -> m (Maybe Text)
- setCompletionItemInfo :: (MonadIO m, IsCompletionItem o) => o -> Text -> m ()
- clearCompletionItemLabel :: (MonadIO m, IsCompletionItem o) => o -> m ()
- constructCompletionItemLabel :: IsCompletionItem o => Text -> IO (GValueConstruct o)
- getCompletionItemLabel :: (MonadIO m, IsCompletionItem o) => o -> m (Maybe Text)
- setCompletionItemLabel :: (MonadIO m, IsCompletionItem o) => o -> Text -> m ()
- clearCompletionItemMarkup :: (MonadIO m, IsCompletionItem o) => o -> m ()
- constructCompletionItemMarkup :: IsCompletionItem o => Text -> IO (GValueConstruct o)
- getCompletionItemMarkup :: (MonadIO m, IsCompletionItem o) => o -> m (Maybe Text)
- setCompletionItemMarkup :: (MonadIO m, IsCompletionItem o) => o -> Text -> m ()
- clearCompletionItemText :: (MonadIO m, IsCompletionItem o) => o -> m ()
- constructCompletionItemText :: IsCompletionItem o => Text -> IO (GValueConstruct o)
- getCompletionItemText :: (MonadIO m, IsCompletionItem o) => o -> m (Maybe Text)
- setCompletionItemText :: (MonadIO m, IsCompletionItem o) => o -> Text -> m ()
Exported types
newtype CompletionItem Source #
Memory-managed wrapper type.
CompletionItem (ManagedPtr CompletionItem) |
Instances
GObject CompletionItem Source # | |
Defined in GI.GtkSource.Objects.CompletionItem gobjectType :: IO GType | |
HasParentTypes CompletionItem Source # | |
Defined in GI.GtkSource.Objects.CompletionItem | |
type ParentTypes CompletionItem Source # | |
Defined in GI.GtkSource.Objects.CompletionItem |
class (GObject o, IsDescendantOf CompletionItem o) => IsCompletionItem o Source #
Type class for types which can be safely cast to CompletionItem
, for instance with toCompletionItem
.
Instances
(GObject o, IsDescendantOf CompletionItem o) => IsCompletionItem o Source # | |
Defined in GI.GtkSource.Objects.CompletionItem |
toCompletionItem :: (MonadIO m, IsCompletionItem o) => o -> m CompletionItem Source #
Cast to CompletionItem
, for types for which this is known to be safe. For general casts, use castTo
.
noCompletionItem :: Maybe CompletionItem Source #
A convenience alias for Nothing
:: Maybe
CompletionItem
.
Methods
new
:: (HasCallStack, MonadIO m, IsPixbuf a) | |
=> Text |
|
-> Text |
|
-> Maybe a |
|
-> Maybe Text |
|
-> m CompletionItem | Returns: a new |
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
:: (HasCallStack, MonadIO m) | |
=> m CompletionItem | Returns: a new |
Creates a new CompletionItem
. The desired properties need to be set
afterwards.
Since: 3.24
newFromStock
completionItemNewFromStock Source #
:: (HasCallStack, MonadIO m) | |
=> Maybe Text |
|
-> Text |
|
-> Text |
|
-> Maybe Text |
|
-> m CompletionItem | Returns: a new |
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 Source #
:: (HasCallStack, MonadIO m, IsPixbuf a) | |
=> Text |
|
-> Text |
|
-> Maybe a |
|
-> Maybe Text |
|
-> m CompletionItem | Returns: a new |
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 Source #
:: (HasCallStack, MonadIO m, IsCompletionItem a, IsIcon b) | |
=> a |
|
-> Maybe b | |
-> m () |
No description available in the introspection data.
Since: 3.24
setIcon
completionItemSetIcon Source #
:: (HasCallStack, MonadIO m, IsCompletionItem a, IsPixbuf b) | |
=> a |
|
-> Maybe b | |
-> m () |
No description available in the introspection data.
Since: 3.24
setIconName
completionItemSetIconName Source #
:: (HasCallStack, MonadIO m, IsCompletionItem a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
No description available in the introspection data.
Since: 3.24
setInfo
completionItemSetInfo Source #
:: (HasCallStack, MonadIO m, IsCompletionItem a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
No description available in the introspection data.
Since: 3.24
setLabel
completionItemSetLabel Source #
:: (HasCallStack, MonadIO m, IsCompletionItem a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
No description available in the introspection data.
Since: 3.24
setMarkup
completionItemSetMarkup Source #
:: (HasCallStack, MonadIO m, IsCompletionItem a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
No description available in the introspection data.
Since: 3.24
setText
completionItemSetText Source #
:: (HasCallStack, MonadIO m, IsCompletionItem a) | |
=> a |
|
-> Maybe Text |
|
-> 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 () Source #
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) Source #
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) Source #
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 () Source #
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 () Source #
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) Source #
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) Source #
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 () Source #
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 () Source #
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) Source #
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) Source #
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 () Source #
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 () Source #
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) Source #
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) Source #
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 () Source #
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 () Source #
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) Source #
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) Source #
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 () Source #
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 () Source #
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) Source #
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) Source #
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 () Source #
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 () Source #
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) Source #
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) Source #
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 () Source #
Set the value of the “text
” property.
When overloading is enabled, this is equivalent to
set
completionItem [ #text:=
value ]