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.Gtk.Objects.Entry

Contents

Exported types
Methods
Properties
Signals

Description

GtkEntry is a single line text entry widget.

An example GtkEntry

A fairly large set of key bindings are supported by default. If the entered text is longer than the allocation of the widget, the widget will scroll so that the cursor position is visible.

When using an entry for passwords and other sensitive information, it can be put into “password mode” using entrySetVisibility. In this mode, entered text is displayed using a “invisible” character. By default, GTK picks the best invisible character that is available in the current font, but it can be changed with entrySetInvisibleChar.

GtkEntry has the ability to display progress or activity information behind the text. To make an entry display such information, use entrySetProgressFraction or entrySetProgressPulseStep.

Additionally, GtkEntry can show icons at either side of the entry. These icons can be activatable by clicking, can be set up as drag source and can have tooltips. To add an icon, use entrySetIconFromGicon or one of the various other functions that set an icon from an icon name or a paintable. To trigger an action when the user clicks an icon, connect to the Entry::iconPress signal. To allow DND operations from an icon, use entrySetIconDragSource. To set a tooltip on an icon, use entrySetIconTooltipText or the corresponding function for markup.

Note that functionality or information that is only available by clicking on an icon in an entry may not be accessible at all to users which are not able to use a mouse or other pointing device. It is therefore recommended that any such functionality should also be available by other means, e.g. via the context menu of the entry.

CSS nodes

entry[.flat][.warning][.error]
├── text[.readonly]
├── image.left
├── image.right
╰── [progress[.pulse]]

GtkEntry has a main node with the name entry. Depending on the properties of the entry, the style classes .read-only and .flat may appear. The style classes .warning and .error may also be used with entries.

When the entry shows icons, it adds subnodes with the name image and the style class .left or .right, depending on where the icon appears.

When the entry shows progress, it adds a subnode with the name progress. The node has the style class .pulse when the shown progress is pulsing.

For all the subnodes added to the text node in various situations, see Text.

GtkEntry as GtkBuildable

The GtkEntry implementation of the GtkBuildable interface supports a custom <attributes> element, which supports any number of <attribute> elements. The <attribute> element has attributes named “name“, “value“, “start“ and “end“ and allows you to specify PangoAttribute values for this label.

An example of a UI definition fragment specifying Pango attributes:

xml code

<object class="GtkEntry">
  <attributes>
    <attribute name="weight" value="PANGO_WEIGHT_BOLD"/>
    <attribute name="background" value="red" start="5" end="10"/>
  </attributes>
</object>

The start and end attributes specify the range of characters to which the Pango attribute applies. If start and end are not specified, the attribute is applied to the whole text. Note that specifying ranges does not make much sense with translatable attributes. Use markup embedded in the translatable content instead.

Accessibility

GtkEntry uses the AccessibleRoleTextBox role.

Synopsis

newtype Entry = Entry (ManagedPtr Entry)
class (GObject o, IsDescendantOf Entry o) => IsEntry o
toEntry :: (MonadIO m, IsEntry o) => o -> m Entry
entryGetActivatesDefault :: (HasCallStack, MonadIO m, IsEntry a) => a -> m Bool
entryGetAlignment :: (HasCallStack, MonadIO m, IsEntry a) => a -> m Float
entryGetAttributes :: (HasCallStack, MonadIO m, IsEntry a) => a -> m (Maybe AttrList)
entryGetBuffer :: (HasCallStack, MonadIO m, IsEntry a) => a -> m EntryBuffer
entryGetCompletion :: (HasCallStack, MonadIO m, IsEntry a) => a -> m (Maybe EntryCompletion)
entryGetCurrentIconDragSource :: (HasCallStack, MonadIO m, IsEntry a) => a -> m Int32
entryGetExtraMenu :: (HasCallStack, MonadIO m, IsEntry a) => a -> m (Maybe MenuModel)
entryGetHasFrame :: (HasCallStack, MonadIO m, IsEntry a) => a -> m Bool
entryGetIconActivatable :: (HasCallStack, MonadIO m, IsEntry a) => a -> EntryIconPosition -> m Bool
entryGetIconArea :: (HasCallStack, MonadIO m, IsEntry a) => a -> EntryIconPosition -> m Rectangle
entryGetIconAtPos :: (HasCallStack, MonadIO m, IsEntry a) => a -> Int32 -> Int32 -> m Int32
entryGetIconGicon :: (HasCallStack, MonadIO m, IsEntry a) => a -> EntryIconPosition -> m (Maybe Icon)
entryGetIconName :: (HasCallStack, MonadIO m, IsEntry a) => a -> EntryIconPosition -> m (Maybe Text)
entryGetIconPaintable :: (HasCallStack, MonadIO m, IsEntry a) => a -> EntryIconPosition -> m (Maybe Paintable)
entryGetIconSensitive :: (HasCallStack, MonadIO m, IsEntry a) => a -> EntryIconPosition -> m Bool
entryGetIconStorageType :: (HasCallStack, MonadIO m, IsEntry a) => a -> EntryIconPosition -> m ImageType
entryGetIconTooltipMarkup :: (HasCallStack, MonadIO m, IsEntry a) => a -> EntryIconPosition -> m (Maybe Text)
entryGetIconTooltipText :: (HasCallStack, MonadIO m, IsEntry a) => a -> EntryIconPosition -> m (Maybe Text)
entryGetInputHints :: (HasCallStack, MonadIO m, IsEntry a) => a -> m [InputHints]
entryGetInputPurpose :: (HasCallStack, MonadIO m, IsEntry a) => a -> m InputPurpose
entryGetInvisibleChar :: (HasCallStack, MonadIO m, IsEntry a) => a -> m Char
entryGetMaxLength :: (HasCallStack, MonadIO m, IsEntry a) => a -> m Int32
entryGetOverwriteMode :: (HasCallStack, MonadIO m, IsEntry a) => a -> m Bool
entryGetPlaceholderText :: (HasCallStack, MonadIO m, IsEntry a) => a -> m (Maybe Text)
entryGetProgressFraction :: (HasCallStack, MonadIO m, IsEntry a) => a -> m Double
entryGetProgressPulseStep :: (HasCallStack, MonadIO m, IsEntry a) => a -> m Double
entryGetTabs :: (HasCallStack, MonadIO m, IsEntry a) => a -> m (Maybe TabArray)
entryGetTextLength :: (HasCallStack, MonadIO m, IsEntry a) => a -> m Word16
entryGetVisibility :: (HasCallStack, MonadIO m, IsEntry a) => a -> m Bool
entryGrabFocusWithoutSelecting :: (HasCallStack, MonadIO m, IsEntry a) => a -> m Bool
entryNew :: (HasCallStack, MonadIO m) => m Entry
entryNewWithBuffer :: (HasCallStack, MonadIO m, IsEntryBuffer a) => a -> m Entry
entryProgressPulse :: (HasCallStack, MonadIO m, IsEntry a) => a -> m ()
entryResetImContext :: (HasCallStack, MonadIO m, IsEntry a) => a -> m ()
entrySetActivatesDefault :: (HasCallStack, MonadIO m, IsEntry a) => a -> Bool -> m ()
entrySetAlignment :: (HasCallStack, MonadIO m, IsEntry a) => a -> Float -> m ()
entrySetAttributes :: (HasCallStack, MonadIO m, IsEntry a) => a -> AttrList -> m ()
entrySetBuffer :: (HasCallStack, MonadIO m, IsEntry a, IsEntryBuffer b) => a -> b -> m ()
entrySetCompletion :: (HasCallStack, MonadIO m, IsEntry a, IsEntryCompletion b) => a -> Maybe b -> m ()
entrySetExtraMenu :: (HasCallStack, MonadIO m, IsEntry a, IsMenuModel b) => a -> Maybe b -> m ()
entrySetHasFrame :: (HasCallStack, MonadIO m, IsEntry a) => a -> Bool -> m ()
entrySetIconActivatable :: (HasCallStack, MonadIO m, IsEntry a) => a -> EntryIconPosition -> Bool -> m ()
entrySetIconDragSource :: (HasCallStack, MonadIO m, IsEntry a, IsContentProvider b) => a -> EntryIconPosition -> b -> [DragAction] -> m ()
entrySetIconFromGicon :: (HasCallStack, MonadIO m, IsEntry a, IsIcon b) => a -> EntryIconPosition -> Maybe b -> m ()
entrySetIconFromIconName :: (HasCallStack, MonadIO m, IsEntry a) => a -> EntryIconPosition -> Maybe Text -> m ()
entrySetIconFromPaintable :: (HasCallStack, MonadIO m, IsEntry a, IsPaintable b) => a -> EntryIconPosition -> Maybe b -> m ()
entrySetIconSensitive :: (HasCallStack, MonadIO m, IsEntry a) => a -> EntryIconPosition -> Bool -> m ()
entrySetIconTooltipMarkup :: (HasCallStack, MonadIO m, IsEntry a) => a -> EntryIconPosition -> Maybe Text -> m ()
entrySetIconTooltipText :: (HasCallStack, MonadIO m, IsEntry a) => a -> EntryIconPosition -> Maybe Text -> m ()
entrySetInputHints :: (HasCallStack, MonadIO m, IsEntry a) => a -> [InputHints] -> m ()
entrySetInputPurpose :: (HasCallStack, MonadIO m, IsEntry a) => a -> InputPurpose -> m ()
entrySetInvisibleChar :: (HasCallStack, MonadIO m, IsEntry a) => a -> Char -> m ()
entrySetMaxLength :: (HasCallStack, MonadIO m, IsEntry a) => a -> Int32 -> m ()
entrySetOverwriteMode :: (HasCallStack, MonadIO m, IsEntry a) => a -> Bool -> m ()
entrySetPlaceholderText :: (HasCallStack, MonadIO m, IsEntry a) => a -> Maybe Text -> m ()
entrySetProgressFraction :: (HasCallStack, MonadIO m, IsEntry a) => a -> Double -> m ()
entrySetProgressPulseStep :: (HasCallStack, MonadIO m, IsEntry a) => a -> Double -> m ()
entrySetTabs :: (HasCallStack, MonadIO m, IsEntry a) => a -> Maybe TabArray -> m ()
entrySetVisibility :: (HasCallStack, MonadIO m, IsEntry a) => a -> Bool -> m ()
entryUnsetInvisibleChar :: (HasCallStack, MonadIO m, IsEntry a) => a -> m ()
constructEntryActivatesDefault :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o)
getEntryActivatesDefault :: (MonadIO m, IsEntry o) => o -> m Bool
setEntryActivatesDefault :: (MonadIO m, IsEntry o) => o -> Bool -> m ()
constructEntryAttributes :: (IsEntry o, MonadIO m) => AttrList -> m (GValueConstruct o)
getEntryAttributes :: (MonadIO m, IsEntry o) => o -> m (Maybe AttrList)
setEntryAttributes :: (MonadIO m, IsEntry o) => o -> AttrList -> m ()
constructEntryBuffer :: (IsEntry o, MonadIO m, IsEntryBuffer a) => a -> m (GValueConstruct o)
getEntryBuffer :: (MonadIO m, IsEntry o) => o -> m EntryBuffer
setEntryBuffer :: (MonadIO m, IsEntry o, IsEntryBuffer a) => o -> a -> m ()
clearEntryCompletion :: (MonadIO m, IsEntry o) => o -> m ()
constructEntryCompletion :: (IsEntry o, MonadIO m, IsEntryCompletion a) => a -> m (GValueConstruct o)
getEntryCompletion :: (MonadIO m, IsEntry o) => o -> m (Maybe EntryCompletion)
setEntryCompletion :: (MonadIO m, IsEntry o, IsEntryCompletion a) => o -> a -> m ()
constructEntryEnableEmojiCompletion :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o)
getEntryEnableEmojiCompletion :: (MonadIO m, IsEntry o) => o -> m Bool
setEntryEnableEmojiCompletion :: (MonadIO m, IsEntry o) => o -> Bool -> m ()
clearEntryExtraMenu :: (MonadIO m, IsEntry o) => o -> m ()
constructEntryExtraMenu :: (IsEntry o, MonadIO m, IsMenuModel a) => a -> m (GValueConstruct o)
getEntryExtraMenu :: (MonadIO m, IsEntry o) => o -> m (Maybe MenuModel)
setEntryExtraMenu :: (MonadIO m, IsEntry o, IsMenuModel a) => o -> a -> m ()
constructEntryHasFrame :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o)
getEntryHasFrame :: (MonadIO m, IsEntry o) => o -> m Bool
setEntryHasFrame :: (MonadIO m, IsEntry o) => o -> Bool -> m ()
clearEntryImModule :: (MonadIO m, IsEntry o) => o -> m ()
constructEntryImModule :: (IsEntry o, MonadIO m) => Text -> m (GValueConstruct o)
getEntryImModule :: (MonadIO m, IsEntry o) => o -> m (Maybe Text)
setEntryImModule :: (MonadIO m, IsEntry o) => o -> Text -> m ()
constructEntryInputHints :: (IsEntry o, MonadIO m) => [InputHints] -> m (GValueConstruct o)
getEntryInputHints :: (MonadIO m, IsEntry o) => o -> m [InputHints]
setEntryInputHints :: (MonadIO m, IsEntry o) => o -> [InputHints] -> m ()
constructEntryInputPurpose :: (IsEntry o, MonadIO m) => InputPurpose -> m (GValueConstruct o)
getEntryInputPurpose :: (MonadIO m, IsEntry o) => o -> m InputPurpose
setEntryInputPurpose :: (MonadIO m, IsEntry o) => o -> InputPurpose -> m ()
constructEntryInvisibleChar :: (IsEntry o, MonadIO m) => Word32 -> m (GValueConstruct o)
getEntryInvisibleChar :: (MonadIO m, IsEntry o) => o -> m Word32
setEntryInvisibleChar :: (MonadIO m, IsEntry o) => o -> Word32 -> m ()
constructEntryInvisibleCharSet :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o)
getEntryInvisibleCharSet :: (MonadIO m, IsEntry o) => o -> m Bool
setEntryInvisibleCharSet :: (MonadIO m, IsEntry o) => o -> Bool -> m ()
constructEntryMaxLength :: (IsEntry o, MonadIO m) => Int32 -> m (GValueConstruct o)
getEntryMaxLength :: (MonadIO m, IsEntry o) => o -> m Int32
setEntryMaxLength :: (MonadIO m, IsEntry o) => o -> Int32 -> m ()
constructEntryOverwriteMode :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o)
getEntryOverwriteMode :: (MonadIO m, IsEntry o) => o -> m Bool
setEntryOverwriteMode :: (MonadIO m, IsEntry o) => o -> Bool -> m ()
clearEntryPlaceholderText :: (MonadIO m, IsEntry o) => o -> m ()
constructEntryPlaceholderText :: (IsEntry o, MonadIO m) => Text -> m (GValueConstruct o)
getEntryPlaceholderText :: (MonadIO m, IsEntry o) => o -> m (Maybe Text)
setEntryPlaceholderText :: (MonadIO m, IsEntry o) => o -> Text -> m ()
constructEntryPrimaryIconActivatable :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o)
getEntryPrimaryIconActivatable :: (MonadIO m, IsEntry o) => o -> m Bool
setEntryPrimaryIconActivatable :: (MonadIO m, IsEntry o) => o -> Bool -> m ()
clearEntryPrimaryIconGicon :: (MonadIO m, IsEntry o) => o -> m ()
constructEntryPrimaryIconGicon :: (IsEntry o, MonadIO m, IsIcon a) => a -> m (GValueConstruct o)
getEntryPrimaryIconGicon :: (MonadIO m, IsEntry o) => o -> m (Maybe Icon)
setEntryPrimaryIconGicon :: (MonadIO m, IsEntry o, IsIcon a) => o -> a -> m ()
clearEntryPrimaryIconName :: (MonadIO m, IsEntry o) => o -> m ()
constructEntryPrimaryIconName :: (IsEntry o, MonadIO m) => Text -> m (GValueConstruct o)
getEntryPrimaryIconName :: (MonadIO m, IsEntry o) => o -> m (Maybe Text)
setEntryPrimaryIconName :: (MonadIO m, IsEntry o) => o -> Text -> m ()
clearEntryPrimaryIconPaintable :: (MonadIO m, IsEntry o) => o -> m ()
constructEntryPrimaryIconPaintable :: (IsEntry o, MonadIO m, IsPaintable a) => a -> m (GValueConstruct o)
getEntryPrimaryIconPaintable :: (MonadIO m, IsEntry o) => o -> m (Maybe Paintable)
setEntryPrimaryIconPaintable :: (MonadIO m, IsEntry o, IsPaintable a) => o -> a -> m ()
constructEntryPrimaryIconSensitive :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o)
getEntryPrimaryIconSensitive :: (MonadIO m, IsEntry o) => o -> m Bool
setEntryPrimaryIconSensitive :: (MonadIO m, IsEntry o) => o -> Bool -> m ()
getEntryPrimaryIconStorageType :: (MonadIO m, IsEntry o) => o -> m ImageType
clearEntryPrimaryIconTooltipMarkup :: (MonadIO m, IsEntry o) => o -> m ()
constructEntryPrimaryIconTooltipMarkup :: (IsEntry o, MonadIO m) => Text -> m (GValueConstruct o)
getEntryPrimaryIconTooltipMarkup :: (MonadIO m, IsEntry o) => o -> m (Maybe Text)
setEntryPrimaryIconTooltipMarkup :: (MonadIO m, IsEntry o) => o -> Text -> m ()
clearEntryPrimaryIconTooltipText :: (MonadIO m, IsEntry o) => o -> m ()
constructEntryPrimaryIconTooltipText :: (IsEntry o, MonadIO m) => Text -> m (GValueConstruct o)
getEntryPrimaryIconTooltipText :: (MonadIO m, IsEntry o) => o -> m (Maybe Text)
setEntryPrimaryIconTooltipText :: (MonadIO m, IsEntry o) => o -> Text -> m ()
constructEntryProgressFraction :: (IsEntry o, MonadIO m) => Double -> m (GValueConstruct o)
getEntryProgressFraction :: (MonadIO m, IsEntry o) => o -> m Double
setEntryProgressFraction :: (MonadIO m, IsEntry o) => o -> Double -> m ()
constructEntryProgressPulseStep :: (IsEntry o, MonadIO m) => Double -> m (GValueConstruct o)
getEntryProgressPulseStep :: (MonadIO m, IsEntry o) => o -> m Double
setEntryProgressPulseStep :: (MonadIO m, IsEntry o) => o -> Double -> m ()
getEntryScrollOffset :: (MonadIO m, IsEntry o) => o -> m Int32
constructEntrySecondaryIconActivatable :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o)
getEntrySecondaryIconActivatable :: (MonadIO m, IsEntry o) => o -> m Bool
setEntrySecondaryIconActivatable :: (MonadIO m, IsEntry o) => o -> Bool -> m ()
clearEntrySecondaryIconGicon :: (MonadIO m, IsEntry o) => o -> m ()
constructEntrySecondaryIconGicon :: (IsEntry o, MonadIO m, IsIcon a) => a -> m (GValueConstruct o)
getEntrySecondaryIconGicon :: (MonadIO m, IsEntry o) => o -> m (Maybe Icon)
setEntrySecondaryIconGicon :: (MonadIO m, IsEntry o, IsIcon a) => o -> a -> m ()
clearEntrySecondaryIconName :: (MonadIO m, IsEntry o) => o -> m ()
constructEntrySecondaryIconName :: (IsEntry o, MonadIO m) => Text -> m (GValueConstruct o)
getEntrySecondaryIconName :: (MonadIO m, IsEntry o) => o -> m (Maybe Text)
setEntrySecondaryIconName :: (MonadIO m, IsEntry o) => o -> Text -> m ()
clearEntrySecondaryIconPaintable :: (MonadIO m, IsEntry o) => o -> m ()
constructEntrySecondaryIconPaintable :: (IsEntry o, MonadIO m, IsPaintable a) => a -> m (GValueConstruct o)
getEntrySecondaryIconPaintable :: (MonadIO m, IsEntry o) => o -> m (Maybe Paintable)
setEntrySecondaryIconPaintable :: (MonadIO m, IsEntry o, IsPaintable a) => o -> a -> m ()
constructEntrySecondaryIconSensitive :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o)
getEntrySecondaryIconSensitive :: (MonadIO m, IsEntry o) => o -> m Bool
setEntrySecondaryIconSensitive :: (MonadIO m, IsEntry o) => o -> Bool -> m ()
getEntrySecondaryIconStorageType :: (MonadIO m, IsEntry o) => o -> m ImageType
clearEntrySecondaryIconTooltipMarkup :: (MonadIO m, IsEntry o) => o -> m ()
constructEntrySecondaryIconTooltipMarkup :: (IsEntry o, MonadIO m) => Text -> m (GValueConstruct o)
getEntrySecondaryIconTooltipMarkup :: (MonadIO m, IsEntry o) => o -> m (Maybe Text)
setEntrySecondaryIconTooltipMarkup :: (MonadIO m, IsEntry o) => o -> Text -> m ()
clearEntrySecondaryIconTooltipText :: (MonadIO m, IsEntry o) => o -> m ()
constructEntrySecondaryIconTooltipText :: (IsEntry o, MonadIO m) => Text -> m (GValueConstruct o)
getEntrySecondaryIconTooltipText :: (MonadIO m, IsEntry o) => o -> m (Maybe Text)
setEntrySecondaryIconTooltipText :: (MonadIO m, IsEntry o) => o -> Text -> m ()
constructEntryShowEmojiIcon :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o)
getEntryShowEmojiIcon :: (MonadIO m, IsEntry o) => o -> m Bool
setEntryShowEmojiIcon :: (MonadIO m, IsEntry o) => o -> Bool -> m ()
clearEntryTabs :: (MonadIO m, IsEntry o) => o -> m ()
constructEntryTabs :: (IsEntry o, MonadIO m) => TabArray -> m (GValueConstruct o)
getEntryTabs :: (MonadIO m, IsEntry o) => o -> m (Maybe TabArray)
setEntryTabs :: (MonadIO m, IsEntry o) => o -> TabArray -> m ()
getEntryTextLength :: (MonadIO m, IsEntry o) => o -> m Word32
constructEntryTruncateMultiline :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o)
getEntryTruncateMultiline :: (MonadIO m, IsEntry o) => o -> m Bool
setEntryTruncateMultiline :: (MonadIO m, IsEntry o) => o -> Bool -> m ()
constructEntryVisibility :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o)
getEntryVisibility :: (MonadIO m, IsEntry o) => o -> m Bool
setEntryVisibility :: (MonadIO m, IsEntry o) => o -> Bool -> m ()
type EntryActivateCallback = IO ()
afterEntryActivate :: (IsEntry a, MonadIO m) => a -> ((?self :: a) => EntryActivateCallback) -> m SignalHandlerId
onEntryActivate :: (IsEntry a, MonadIO m) => a -> ((?self :: a) => EntryActivateCallback) -> m SignalHandlerId
type EntryIconPressCallback = EntryIconPosition -> IO ()
afterEntryIconPress :: (IsEntry a, MonadIO m) => a -> ((?self :: a) => EntryIconPressCallback) -> m SignalHandlerId
onEntryIconPress :: (IsEntry a, MonadIO m) => a -> ((?self :: a) => EntryIconPressCallback) -> m SignalHandlerId
type EntryIconReleaseCallback = EntryIconPosition -> IO ()
afterEntryIconRelease :: (IsEntry a, MonadIO m) => a -> ((?self :: a) => EntryIconReleaseCallback) -> m SignalHandlerId
onEntryIconRelease :: (IsEntry a, MonadIO m) => a -> ((?self :: a) => EntryIconReleaseCallback) -> m SignalHandlerId

Exported types

newtype Entry Source #

Memory-managed wrapper type.

Constructors

Entry (ManagedPtr Entry)

Instances

Instances details

Eq Entry Source #
Instance details Defined in GI.Gtk.Objects.Entry Methods (==) :: Entry -> Entry -> Bool # (/=) :: Entry -> Entry -> Bool #
GObject Entry Source #
Instance details Defined in GI.Gtk.Objects.Entry
ManagedPtrNewtype Entry Source #
Instance details Defined in GI.Gtk.Objects.Entry Methods toManagedPtr :: Entry -> ManagedPtr Entry #
TypedObject Entry Source #
Instance details Defined in GI.Gtk.Objects.Entry Methods glibType :: IO GType #
HasParentTypes Entry Source #
Instance details Defined in GI.Gtk.Objects.Entry
IsGValue (Maybe Entry) Source #	Convert `Entry` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.Entry Methods gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe Entry -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe Entry) #
type ParentTypes Entry Source #
Instance details Defined in GI.Gtk.Objects.Entry type ParentTypes Entry = '[Widget, Object, Accessible, Buildable, CellEditable, ConstraintTarget, Editable]

class (GObject o, IsDescendantOf Entry o) => IsEntry o Source #

Type class for types which can be safely cast to Entry, for instance with toEntry.

Instances

Instances details

(GObject o, IsDescendantOf Entry o) => IsEntry o Source #
Instance details Defined in GI.Gtk.Objects.Entry

toEntry :: (MonadIO m, IsEntry o) => o -> m Entry Source #

Cast to Entry, 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

Expand

getActivatesDefault

entryGetActivatesDefault Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m Bool	Returns: `True` if the entry will activate the default widget

Retrieves the value set by entrySetActivatesDefault.

getAlignment

entryGetAlignment Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m Float	Returns: the alignment

Gets the value set by entrySetAlignment.

getAttributes

entryGetAttributes Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m (Maybe AttrList)	Returns: the attribute list

Gets the attribute list of the GtkEntry.

See entrySetAttributes.

getBuffer

entryGetBuffer Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m EntryBuffer	Returns: A `GtkEntryBuffer` object.

Get the GtkEntryBuffer object which holds the text for this widget.

getCompletion

entryGetCompletion Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: A `GtkEntry`
-> m (Maybe EntryCompletion)	Returns: The auxiliary completion object currently in use by `entry`

Returns the auxiliary completion object currently in use by entry.

getCurrentIconDragSource

entryGetCurrentIconDragSource Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m Int32	Returns: index of the icon which is the source of the current DND operation, or -1.

Returns the index of the icon which is the source of the current DND operation, or -1.

getExtraMenu

entryGetExtraMenu Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m (Maybe MenuModel)	Returns: the menu model

Gets the menu model set with entrySetExtraMenu.

getHasFrame

entryGetHasFrame Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m Bool	Returns: whether the entry has a beveled frame

Gets the value set by entrySetHasFrame.

getIconActivatable

entryGetIconActivatable Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> EntryIconPosition	`iconPos`: Icon position
-> m Bool	Returns: `True` if the icon is activatable.

Returns whether the icon is activatable.

getIconArea

entryGetIconArea Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: A `GtkEntry`
-> EntryIconPosition	`iconPos`: Icon position
-> m Rectangle

Gets the area where entry’s icon at iconPos is drawn.

This function is useful when drawing something to the entry in a draw callback.

If the entry is not realized or has no icon at the given position, iconArea is filled with zeros. Otherwise, iconArea will be filled with the icon's allocation, relative to entry's allocation.

getIconAtPos

entryGetIconAtPos Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> Int32	`x`: the x coordinate of the position to find, relative to `entry`
-> Int32	`y`: the y coordinate of the position to find, relative to `entry`
-> m Int32	Returns: the index of the icon at the given position, or -1

Finds the icon at the given position and return its index.

The position’s coordinates are relative to the entry’s top left corner. If x, y doesn’t lie inside an icon, -1 is returned. This function is intended for use in a Widget::queryTooltip signal handler.

getIconGicon

entryGetIconGicon Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: A `GtkEntry`
-> EntryIconPosition	`iconPos`: Icon position
-> m (Maybe Icon)	Returns: A `GIcon`

Retrieves the GIcon used for the icon.

Nothing will be returned if there is no icon or if the icon was set by some other method (e.g., by GdkPaintable or icon name).

getIconName

entryGetIconName Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: A `GtkEntry`
-> EntryIconPosition	`iconPos`: Icon position
-> m (Maybe Text)	Returns: An icon name

Retrieves the icon name used for the icon.

Nothing is returned if there is no icon or if the icon was set by some other method (e.g., by GdkPaintable or gicon).

getIconPaintable

entryGetIconPaintable Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: A `GtkEntry`
-> EntryIconPosition	`iconPos`: Icon position
-> m (Maybe Paintable)	Returns: A `GdkPaintable` if no icon is set for this position or the icon set is not a `GdkPaintable`.

Retrieves the GdkPaintable used for the icon.

If no GdkPaintable was used for the icon, Nothing is returned.

getIconSensitive

entryGetIconSensitive Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> EntryIconPosition	`iconPos`: Icon position
-> m Bool	Returns: `True` if the icon is sensitive.

Returns whether the icon appears sensitive or insensitive.

getIconStorageType

entryGetIconStorageType Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> EntryIconPosition	`iconPos`: Icon position
-> m ImageType	Returns: image representation being used

Gets the type of representation being used by the icon to store image data.

If the icon has no image data, the return value will be ImageTypeEmpty.

getIconTooltipMarkup

entryGetIconTooltipMarkup Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> EntryIconPosition	`iconPos`: the icon position
-> m (Maybe Text)	Returns: the tooltip text

Gets the contents of the tooltip on the icon at the specified position in entry.

getIconTooltipText

entryGetIconTooltipText Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> EntryIconPosition	`iconPos`: the icon position
-> m (Maybe Text)	Returns: the tooltip text

Gets the contents of the tooltip on the icon at the specified position in entry.

getInputHints

entryGetInputHints Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m [InputHints]	Returns: the input hints

Gets the input hints of this GtkEntry.

getInputPurpose

entryGetInputPurpose Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m InputPurpose	Returns: the input purpose

Gets the input purpose of the GtkEntry.

getInvisibleChar

entryGetInvisibleChar Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m Char	Returns: the current invisible char, or 0, if the entry does not show invisible text at all.

Retrieves the character displayed in place of the actual text in “password mode”.

getMaxLength

entryGetMaxLength Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m Int32	Returns: the maximum allowed number of characters in `GtkEntry`, or 0 if there is no maximum.

Retrieves the maximum allowed length of the text in entry.

See entrySetMaxLength.

getOverwriteMode

entryGetOverwriteMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m Bool	Returns: whether the text is overwritten when typing.

Gets whether the GtkEntry is in overwrite mode.

getPlaceholderText

entryGetPlaceholderText Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m (Maybe Text)	Returns: a pointer to the placeholder text as a string. This string points to internally allocated storage in the widget and must not be freed, modified or stored. If no placeholder text has been set, `Nothing` will be returned.

Retrieves the text that will be displayed when entry is empty and unfocused

getProgressFraction

entryGetProgressFraction Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m Double	Returns: a fraction from 0.0 to 1.0

Returns the current fraction of the task that’s been completed.

See entrySetProgressFraction.

getProgressPulseStep

entryGetProgressPulseStep Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m Double	Returns: a fraction from 0.0 to 1.0

Retrieves the pulse step set with entrySetProgressPulseStep.

getTabs

entryGetTabs Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m (Maybe TabArray)	Returns: the tabstops

Gets the tabstops of the `GtkEntry.

See entrySetTabs.

getTextLength

entryGetTextLength Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m Word16	Returns: the current number of characters in `GtkEntry`, or 0 if there are none.

Retrieves the current length of the text in entry.

This is equivalent to getting entry's GtkEntryBuffer and calling entryBufferGetLength on it.

getVisibility

entryGetVisibility Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m Bool	Returns: `True` if the text is currently visible

Retrieves whether the text in entry is visible.

See entrySetVisibility.

grabFocusWithoutSelecting

entryGrabFocusWithoutSelecting Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m Bool	Returns: `True` if focus is now inside `self`

Causes entry to have keyboard focus.

It behaves like widgetGrabFocus, except that it doesn't select the contents of the entry. You only want to call this on some special entries which the user usually doesn't want to replace all text in, such as search-as-you-type entries.

new

entryNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m Entry	Returns: a new `GtkEntry`.

Creates a new entry.

newWithBuffer

entryNewWithBuffer Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntryBuffer a)
=> a	`buffer`: The buffer to use for the new `GtkEntry`.
-> m Entry	Returns: a new `GtkEntry`

Creates a new entry with the specified text buffer.

progressPulse

entryProgressPulse Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m ()

Indicates that some progress is made, but you don’t know how much.

Causes the entry’s progress indicator to enter “activity mode”, where a block bounces back and forth. Each call to entryProgressPulse causes the block to move by a little bit (the amount of movement per pulse is determined by entrySetProgressPulseStep).

resetImContext

entryResetImContext Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m ()

Reset the input method context of the entry if needed.

This can be necessary in the case where modifying the buffer would confuse on-going input method behavior.

setActivatesDefault

entrySetActivatesDefault Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> Bool	`setting`: `True` to activate window’s default widget on Enter keypress
-> m ()

Sets whether pressing Enter in the entry will activate the default widget for the window containing the entry.

This usually means that the dialog containing the entry will be closed, since the default widget is usually one of the dialog buttons.

setAlignment

entrySetAlignment Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> Float	`xalign`: The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts
-> m ()

Sets the alignment for the contents of the entry.

This controls the horizontal positioning of the contents when the displayed text is shorter than the width of the entry.

setAttributes

entrySetAttributes Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> AttrList	`attrs`: a `PangoAttrList`
-> m ()

Sets a PangoAttrList.

The attributes in the list are applied to the entry text.

Since the attributes will be applies to text that changes as the user types, it makes most sense to use attributes with unlimited extent.

setBuffer

entrySetBuffer Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a, IsEntryBuffer b)
=> a	`entry`: a `GtkEntry`
-> b	`buffer`: a `GtkEntryBuffer`
-> m ()

Set the GtkEntryBuffer object which holds the text for this widget.

setCompletion

entrySetCompletion Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a, IsEntryCompletion b)
=> a	`entry`: A `GtkEntry`
-> Maybe b	`completion`: The `GtkEntryCompletion`
-> m ()

Sets completion to be the auxiliary completion object to use with entry.

All further configuration of the completion mechanism is done on completion using the GtkEntryCompletion API. Completion is disabled if completion is set to Nothing.

setExtraMenu

entrySetExtraMenu Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a, IsMenuModel b)
=> a	`entry`: a `GtkEntry`
-> Maybe b	`model`: a `GMenuModel`
-> m ()

Sets a menu model to add when constructing the context menu for entry.

setHasFrame

entrySetHasFrame Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> Bool	`setting`: new value
-> m ()

Sets whether the entry has a beveled frame around it.

setIconActivatable

entrySetIconActivatable Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: A `GtkEntry`
-> EntryIconPosition	`iconPos`: Icon position
-> Bool	`activatable`: `True` if the icon should be activatable
-> m ()

Sets whether the icon is activatable.

setIconDragSource

entrySetIconDragSource Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a, IsContentProvider b)
=> a	`entry`: a `GtkEntry`
-> EntryIconPosition	`iconPos`: icon position
-> b	`provider`: a `GdkContentProvider`
-> [DragAction]	`actions`: a bitmask of the allowed drag actions
-> m ()

Sets up the icon at the given position as drag source.

This makes it so that GTK will start a drag operation when the user clicks and drags the icon.

setIconFromGicon

entrySetIconFromGicon Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a, IsIcon b)
=> a	`entry`: A `GtkEntry`
-> EntryIconPosition	`iconPos`: The position at which to set the icon
-> Maybe b	`icon`: The icon to set
-> m ()

Sets the icon shown in the entry at the specified position from the current icon theme.

If the icon isn’t known, a “broken image” icon will be displayed instead.

If icon is Nothing, no icon will be shown in the specified position.

setIconFromIconName

entrySetIconFromIconName Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: A `GtkEntry`
-> EntryIconPosition	`iconPos`: The position at which to set the icon
-> Maybe Text	`iconName`: An icon name
-> m ()

Sets the icon shown in the entry at the specified position from the current icon theme.

If the icon name isn’t known, a “broken image” icon will be displayed instead.

If iconName is Nothing, no icon will be shown in the specified position.

setIconFromPaintable

entrySetIconFromPaintable Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a, IsPaintable b)
=> a	`entry`: a `GtkEntry`
-> EntryIconPosition	`iconPos`: Icon position
-> Maybe b	`paintable`: A `GdkPaintable`
-> m ()

Sets the icon shown in the specified position using a GdkPaintable.

If paintable is Nothing, no icon will be shown in the specified position.

setIconSensitive

entrySetIconSensitive Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: A `GtkEntry`
-> EntryIconPosition	`iconPos`: Icon position
-> Bool	`sensitive`: Specifies whether the icon should appear sensitive or insensitive
-> m ()

Sets the sensitivity for the specified icon.

setIconTooltipMarkup

entrySetIconTooltipMarkup Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> EntryIconPosition	`iconPos`: the icon position
-> Maybe Text	`tooltip`: the contents of the tooltip for the icon
-> m ()

Sets tooltip as the contents of the tooltip for the icon at the specified position.

tooltip is assumed to be marked up with Pango Markup.

Use Nothing for tooltip to remove an existing tooltip.

setIconTooltipText

entrySetIconTooltipText Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> EntryIconPosition	`iconPos`: the icon position
-> Maybe Text	`tooltip`: the contents of the tooltip for the icon
-> m ()

Sets tooltip as the contents of the tooltip for the icon at the specified position.

Use Nothing for tooltip to remove an existing tooltip.

If you unset the widget tooltip via widgetSetTooltipText or widgetSetTooltipMarkup, this sets Widget:hasTooltip to False, which suppresses icon tooltips too. You can resolve this by then calling widgetSetHasTooltip to set Widget:hasTooltip back to True, or setting at least one non-empty tooltip on any icon achieves the same result.

setInputHints

entrySetInputHints Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> [InputHints]	`hints`: the hints
-> m ()

Set additional hints which allow input methods to fine-tune their behavior.

setInputPurpose

entrySetInputPurpose Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> InputPurpose	`purpose`: the purpose
-> m ()

Sets the input purpose which can be used by input methods to adjust their behavior.

setInvisibleChar

entrySetInvisibleChar Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> Char	`ch`: a Unicode character
-> m ()

Sets the character to use in place of the actual text in “password mode”.

See entrySetVisibility for how to enable “password mode”.

By default, GTK picks the best invisible char available in the current font. If you set the invisible char to 0, then the user will get no feedback at all; there will be no text on the screen as they type.

setMaxLength

entrySetMaxLength Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> Int32	`max`: the maximum length of the entry, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be clamped to the range 0-65536.
-> m ()

Sets the maximum allowed length of the contents of the widget.

If the current contents are longer than the given length, then they will be truncated to fit. The length is is in characters.

This is equivalent to getting entry's GtkEntryBuffer and calling entryBufferSetMaxLength on it.

setOverwriteMode

entrySetOverwriteMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> Bool	`overwrite`: new value
-> m ()

Sets whether the text is overwritten when typing in the GtkEntry.

setPlaceholderText

entrySetPlaceholderText Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> Maybe Text	`text`: a string to be displayed when `entry` is empty and unfocused
-> m ()

Sets text to be displayed in entry when it is empty.

This can be used to give a visual hint of the expected contents of the GtkEntry.

setProgressFraction

entrySetProgressFraction Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> Double	`fraction`: fraction of the task that’s been completed
-> m ()

Causes the entry’s progress indicator to “fill in” the given fraction of the bar.

The fraction should be between 0.0 and 1.0, inclusive.

setProgressPulseStep

entrySetProgressPulseStep Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> Double	`fraction`: fraction between 0.0 and 1.0
-> m ()

Sets the fraction of total entry width to move the progress bouncing block for each pulse.

Use entryProgressPulse to pulse the progress.

setTabs

entrySetTabs Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> Maybe TabArray	`tabs`: a `PangoTabArray`
-> m ()

Sets a PangoTabArray.

The tabstops in the array are applied to the entry text.

setVisibility

entrySetVisibility Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> Bool	`visible`: `True` if the contents of the entry are displayed as plaintext
-> m ()

Sets whether the contents of the entry are visible or not.

When visibility is set to False, characters are displayed as the invisible char, and will also appear that way when the text in the entry widget is copied elsewhere.

By default, GTK picks the best invisible character available in the current font, but it can be changed with entrySetInvisibleChar.

Note that you probably want to set Entry:inputPurpose to InputPurposePassword or InputPurposePin to inform input methods about the purpose of this entry, in addition to setting visibility to False.

unsetInvisibleChar

entryUnsetInvisibleChar Source #

Arguments

:: (HasCallStack, MonadIO m, IsEntry a)
=> a	`entry`: a `GtkEntry`
-> m ()

Unsets the invisible char, so that the default invisible char is used again. See entrySetInvisibleChar.

Properties

activatesDefault

Whether to activate the default widget when Enter is pressed.

constructEntryActivatesDefault :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getEntryActivatesDefault :: (MonadIO m, IsEntry o) => o -> m Bool Source #

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

get entry #activatesDefault

setEntryActivatesDefault :: (MonadIO m, IsEntry o) => o -> Bool -> m () Source #

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

set entry [ #activatesDefault := value ]

attributes

A list of Pango attributes to apply to the text of the entry.

This is mainly useful to change the size or weight of the text.

The PangoAttribute's startIndex and endIndex must refer to the EntryBuffer text, i.e. without the preedit string.

constructEntryAttributes :: (IsEntry o, MonadIO m) => AttrList -> m (GValueConstruct o) Source #

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

getEntryAttributes :: (MonadIO m, IsEntry o) => o -> m (Maybe AttrList) Source #

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

get entry #attributes

setEntryAttributes :: (MonadIO m, IsEntry o) => o -> AttrList -> m () Source #

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

set entry [ #attributes := value ]

buffer

The buffer object which actually stores the text.

constructEntryBuffer :: (IsEntry o, MonadIO m, IsEntryBuffer a) => a -> m (GValueConstruct o) Source #

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

getEntryBuffer :: (MonadIO m, IsEntry o) => o -> m EntryBuffer Source #

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

get entry #buffer

setEntryBuffer :: (MonadIO m, IsEntry o, IsEntryBuffer a) => o -> a -> m () Source #

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

set entry [ #buffer := value ]

completion

The auxiliary completion object to use with the entry.

clearEntryCompletion :: (MonadIO m, IsEntry o) => o -> m () Source #

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

clear #completion

constructEntryCompletion :: (IsEntry o, MonadIO m, IsEntryCompletion a) => a -> m (GValueConstruct o) Source #

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

getEntryCompletion :: (MonadIO m, IsEntry o) => o -> m (Maybe EntryCompletion) Source #

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

get entry #completion

setEntryCompletion :: (MonadIO m, IsEntry o, IsEntryCompletion a) => o -> a -> m () Source #

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

set entry [ #completion := value ]

enableEmojiCompletion

Whether to suggest Emoji replacements for :-delimited names like :heart:.

constructEntryEnableEmojiCompletion :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getEntryEnableEmojiCompletion :: (MonadIO m, IsEntry o) => o -> m Bool Source #

Get the value of the “enable-emoji-completion” property. When overloading is enabled, this is equivalent to

get entry #enableEmojiCompletion

setEntryEnableEmojiCompletion :: (MonadIO m, IsEntry o) => o -> Bool -> m () Source #

Set the value of the “enable-emoji-completion” property. When overloading is enabled, this is equivalent to

set entry [ #enableEmojiCompletion := value ]

extraMenu

A menu model whose contents will be appended to the context menu.

clearEntryExtraMenu :: (MonadIO m, IsEntry o) => o -> m () Source #

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

clear #extraMenu

constructEntryExtraMenu :: (IsEntry o, MonadIO m, IsMenuModel a) => a -> m (GValueConstruct o) Source #

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

getEntryExtraMenu :: (MonadIO m, IsEntry o) => o -> m (Maybe MenuModel) Source #

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

get entry #extraMenu

setEntryExtraMenu :: (MonadIO m, IsEntry o, IsMenuModel a) => o -> a -> m () Source #

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

set entry [ #extraMenu := value ]

hasFrame

Whehter the entry should draw a frame.

constructEntryHasFrame :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getEntryHasFrame :: (MonadIO m, IsEntry o) => o -> m Bool Source #

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

get entry #hasFrame

setEntryHasFrame :: (MonadIO m, IsEntry o) => o -> Bool -> m () Source #

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

set entry [ #hasFrame := value ]

imModule

Which IM (input method) module should be used for this entry.

See IMContext.

Setting this to a non-Nothing value overrides the system-wide IM module setting. See the GtkSettings Settings:gtkImModule property.

clearEntryImModule :: (MonadIO m, IsEntry o) => o -> m () Source #

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

clear #imModule

constructEntryImModule :: (IsEntry o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getEntryImModule :: (MonadIO m, IsEntry o) => o -> m (Maybe Text) Source #

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

get entry #imModule

setEntryImModule :: (MonadIO m, IsEntry o) => o -> Text -> m () Source #

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

set entry [ #imModule := value ]

inputHints

Additional hints that allow input methods to fine-tune their behavior.

Also see Entry:inputPurpose

constructEntryInputHints :: (IsEntry o, MonadIO m) => [InputHints] -> m (GValueConstruct o) Source #

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

getEntryInputHints :: (MonadIO m, IsEntry o) => o -> m [InputHints] Source #

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

get entry #inputHints

setEntryInputHints :: (MonadIO m, IsEntry o) => o -> [InputHints] -> m () Source #

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

set entry [ #inputHints := value ]

inputPurpose

The purpose of this text field.

This property can be used by on-screen keyboards and other input methods to adjust their behaviour.

Note that setting the purpose to InputPurposePassword or InputPurposePin is independent from setting Entry:visibility.

constructEntryInputPurpose :: (IsEntry o, MonadIO m) => InputPurpose -> m (GValueConstruct o) Source #

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

getEntryInputPurpose :: (MonadIO m, IsEntry o) => o -> m InputPurpose Source #

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

get entry #inputPurpose

setEntryInputPurpose :: (MonadIO m, IsEntry o) => o -> InputPurpose -> m () Source #

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

set entry [ #inputPurpose := value ]

invisibleChar

The character to use when masking entry contents (“password mode”).

constructEntryInvisibleChar :: (IsEntry o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #

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

getEntryInvisibleChar :: (MonadIO m, IsEntry o) => o -> m Word32 Source #

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

get entry #invisibleChar

setEntryInvisibleChar :: (MonadIO m, IsEntry o) => o -> Word32 -> m () Source #

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

set entry [ #invisibleChar := value ]

invisibleCharSet

Whether the invisible char has been set for the GtkEntry.

constructEntryInvisibleCharSet :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getEntryInvisibleCharSet :: (MonadIO m, IsEntry o) => o -> m Bool Source #

Get the value of the “invisible-char-set” property. When overloading is enabled, this is equivalent to

get entry #invisibleCharSet

setEntryInvisibleCharSet :: (MonadIO m, IsEntry o) => o -> Bool -> m () Source #

Set the value of the “invisible-char-set” property. When overloading is enabled, this is equivalent to

set entry [ #invisibleCharSet := value ]

maxLength

Maximum number of characters for this entry.

constructEntryMaxLength :: (IsEntry o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getEntryMaxLength :: (MonadIO m, IsEntry o) => o -> m Int32 Source #

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

get entry #maxLength

setEntryMaxLength :: (MonadIO m, IsEntry o) => o -> Int32 -> m () Source #

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

set entry [ #maxLength := value ]

overwriteMode

If text is overwritten when typing in the GtkEntry.

constructEntryOverwriteMode :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getEntryOverwriteMode :: (MonadIO m, IsEntry o) => o -> m Bool Source #

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

get entry #overwriteMode

setEntryOverwriteMode :: (MonadIO m, IsEntry o) => o -> Bool -> m () Source #

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

set entry [ #overwriteMode := value ]

placeholderText

The text that will be displayed in the GtkEntry when it is empty and unfocused.

clearEntryPlaceholderText :: (MonadIO m, IsEntry o) => o -> m () Source #

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

clear #placeholderText

constructEntryPlaceholderText :: (IsEntry o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getEntryPlaceholderText :: (MonadIO m, IsEntry o) => o -> m (Maybe Text) Source #

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

get entry #placeholderText

setEntryPlaceholderText :: (MonadIO m, IsEntry o) => o -> Text -> m () Source #

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

set entry [ #placeholderText := value ]

primaryIconActivatable

Whether the primary icon is activatable.

GTK emits the Entry::iconPress and Entry::iconRelease signals only on sensitive, activatable icons.

Sensitive, but non-activatable icons can be used for purely informational purposes.

constructEntryPrimaryIconActivatable :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getEntryPrimaryIconActivatable :: (MonadIO m, IsEntry o) => o -> m Bool Source #

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

get entry #primaryIconActivatable

setEntryPrimaryIconActivatable :: (MonadIO m, IsEntry o) => o -> Bool -> m () Source #

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

set entry [ #primaryIconActivatable := value ]

primaryIconGicon

The GIcon to use for the primary icon for the entry.

clearEntryPrimaryIconGicon :: (MonadIO m, IsEntry o) => o -> m () Source #

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

clear #primaryIconGicon

constructEntryPrimaryIconGicon :: (IsEntry o, MonadIO m, IsIcon a) => a -> m (GValueConstruct o) Source #

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

getEntryPrimaryIconGicon :: (MonadIO m, IsEntry o) => o -> m (Maybe Icon) Source #

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

get entry #primaryIconGicon

setEntryPrimaryIconGicon :: (MonadIO m, IsEntry o, IsIcon a) => o -> a -> m () Source #

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

set entry [ #primaryIconGicon := value ]

primaryIconName

The icon name to use for the primary icon for the entry.

clearEntryPrimaryIconName :: (MonadIO m, IsEntry o) => o -> m () Source #

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

clear #primaryIconName

constructEntryPrimaryIconName :: (IsEntry o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getEntryPrimaryIconName :: (MonadIO m, IsEntry o) => o -> m (Maybe Text) Source #

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

get entry #primaryIconName

setEntryPrimaryIconName :: (MonadIO m, IsEntry o) => o -> Text -> m () Source #

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

set entry [ #primaryIconName := value ]

primaryIconPaintable

A GdkPaintable to use as the primary icon for the entry.

clearEntryPrimaryIconPaintable :: (MonadIO m, IsEntry o) => o -> m () Source #

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

clear #primaryIconPaintable

constructEntryPrimaryIconPaintable :: (IsEntry o, MonadIO m, IsPaintable a) => a -> m (GValueConstruct o) Source #

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

getEntryPrimaryIconPaintable :: (MonadIO m, IsEntry o) => o -> m (Maybe Paintable) Source #

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

get entry #primaryIconPaintable

setEntryPrimaryIconPaintable :: (MonadIO m, IsEntry o, IsPaintable a) => o -> a -> m () Source #

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

set entry [ #primaryIconPaintable := value ]

primaryIconSensitive

Whether the primary icon is sensitive.

An insensitive icon appears grayed out. GTK does not emit the Entry::iconPress and Entry::iconRelease signals and does not allow DND from insensitive icons.

An icon should be set insensitive if the action that would trigger when clicked is currently not available.

constructEntryPrimaryIconSensitive :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getEntryPrimaryIconSensitive :: (MonadIO m, IsEntry o) => o -> m Bool Source #

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

get entry #primaryIconSensitive

setEntryPrimaryIconSensitive :: (MonadIO m, IsEntry o) => o -> Bool -> m () Source #

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

set entry [ #primaryIconSensitive := value ]

primaryIconStorageType

The representation which is used for the primary icon of the entry.

getEntryPrimaryIconStorageType :: (MonadIO m, IsEntry o) => o -> m ImageType Source #

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

get entry #primaryIconStorageType

primaryIconTooltipMarkup

The contents of the tooltip on the primary icon, with markup.

Also see entrySetIconTooltipMarkup.

clearEntryPrimaryIconTooltipMarkup :: (MonadIO m, IsEntry o) => o -> m () Source #

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

clear #primaryIconTooltipMarkup

constructEntryPrimaryIconTooltipMarkup :: (IsEntry o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getEntryPrimaryIconTooltipMarkup :: (MonadIO m, IsEntry o) => o -> m (Maybe Text) Source #

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

get entry #primaryIconTooltipMarkup

setEntryPrimaryIconTooltipMarkup :: (MonadIO m, IsEntry o) => o -> Text -> m () Source #

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

set entry [ #primaryIconTooltipMarkup := value ]

primaryIconTooltipText

The contents of the tooltip on the primary icon.

Also see entrySetIconTooltipText.

clearEntryPrimaryIconTooltipText :: (MonadIO m, IsEntry o) => o -> m () Source #

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

clear #primaryIconTooltipText

constructEntryPrimaryIconTooltipText :: (IsEntry o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getEntryPrimaryIconTooltipText :: (MonadIO m, IsEntry o) => o -> m (Maybe Text) Source #

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

get entry #primaryIconTooltipText

setEntryPrimaryIconTooltipText :: (MonadIO m, IsEntry o) => o -> Text -> m () Source #

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

set entry [ #primaryIconTooltipText := value ]

progressFraction

The current fraction of the task that's been completed.

constructEntryProgressFraction :: (IsEntry o, MonadIO m) => Double -> m (GValueConstruct o) Source #

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

getEntryProgressFraction :: (MonadIO m, IsEntry o) => o -> m Double Source #

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

get entry #progressFraction

setEntryProgressFraction :: (MonadIO m, IsEntry o) => o -> Double -> m () Source #

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

set entry [ #progressFraction := value ]

progressPulseStep

The fraction of total entry width to move the progress bouncing block for each pulse.

See entryProgressPulse.

constructEntryProgressPulseStep :: (IsEntry o, MonadIO m) => Double -> m (GValueConstruct o) Source #

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

getEntryProgressPulseStep :: (MonadIO m, IsEntry o) => o -> m Double Source #

Get the value of the “progress-pulse-step” property. When overloading is enabled, this is equivalent to

get entry #progressPulseStep

setEntryProgressPulseStep :: (MonadIO m, IsEntry o) => o -> Double -> m () Source #

Set the value of the “progress-pulse-step” property. When overloading is enabled, this is equivalent to

set entry [ #progressPulseStep := value ]

scrollOffset

Number of pixels of the entry scrolled off the screen to the left.

getEntryScrollOffset :: (MonadIO m, IsEntry o) => o -> m Int32 Source #

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

get entry #scrollOffset

secondaryIconActivatable

Whether the secondary icon is activatable.

GTK emits the Entry::iconPress and Entry::iconRelease signals only on sensitive, activatable icons.

Sensitive, but non-activatable icons can be used for purely informational purposes.

constructEntrySecondaryIconActivatable :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getEntrySecondaryIconActivatable :: (MonadIO m, IsEntry o) => o -> m Bool Source #

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

get entry #secondaryIconActivatable

setEntrySecondaryIconActivatable :: (MonadIO m, IsEntry o) => o -> Bool -> m () Source #

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

set entry [ #secondaryIconActivatable := value ]

secondaryIconGicon

The GIcon to use for the secondary icon for the entry.

clearEntrySecondaryIconGicon :: (MonadIO m, IsEntry o) => o -> m () Source #

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

clear #secondaryIconGicon

constructEntrySecondaryIconGicon :: (IsEntry o, MonadIO m, IsIcon a) => a -> m (GValueConstruct o) Source #

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

getEntrySecondaryIconGicon :: (MonadIO m, IsEntry o) => o -> m (Maybe Icon) Source #

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

get entry #secondaryIconGicon

setEntrySecondaryIconGicon :: (MonadIO m, IsEntry o, IsIcon a) => o -> a -> m () Source #

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

set entry [ #secondaryIconGicon := value ]

secondaryIconName

The icon name to use for the secondary icon for the entry.

clearEntrySecondaryIconName :: (MonadIO m, IsEntry o) => o -> m () Source #

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

clear #secondaryIconName

constructEntrySecondaryIconName :: (IsEntry o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getEntrySecondaryIconName :: (MonadIO m, IsEntry o) => o -> m (Maybe Text) Source #

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

get entry #secondaryIconName

setEntrySecondaryIconName :: (MonadIO m, IsEntry o) => o -> Text -> m () Source #

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

set entry [ #secondaryIconName := value ]

secondaryIconPaintable

A GdkPaintable to use as the secondary icon for the entry.

clearEntrySecondaryIconPaintable :: (MonadIO m, IsEntry o) => o -> m () Source #

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

clear #secondaryIconPaintable

constructEntrySecondaryIconPaintable :: (IsEntry o, MonadIO m, IsPaintable a) => a -> m (GValueConstruct o) Source #

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

getEntrySecondaryIconPaintable :: (MonadIO m, IsEntry o) => o -> m (Maybe Paintable) Source #

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

get entry #secondaryIconPaintable

setEntrySecondaryIconPaintable :: (MonadIO m, IsEntry o, IsPaintable a) => o -> a -> m () Source #

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

set entry [ #secondaryIconPaintable := value ]

secondaryIconSensitive

Whether the secondary icon is sensitive.

An insensitive icon appears grayed out. GTK does not emit the signalgtk.Entry[iconPress and [Entry::iconRelease signals and does not allow DND from insensitive icons.

An icon should be set insensitive if the action that would trigger when clicked is currently not available.

constructEntrySecondaryIconSensitive :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getEntrySecondaryIconSensitive :: (MonadIO m, IsEntry o) => o -> m Bool Source #

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

get entry #secondaryIconSensitive

setEntrySecondaryIconSensitive :: (MonadIO m, IsEntry o) => o -> Bool -> m () Source #

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

set entry [ #secondaryIconSensitive := value ]

secondaryIconStorageType

The representation which is used for the secondary icon of the entry.

getEntrySecondaryIconStorageType :: (MonadIO m, IsEntry o) => o -> m ImageType Source #

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

get entry #secondaryIconStorageType

secondaryIconTooltipMarkup

The contents of the tooltip on the secondary icon, with markup.

Also see entrySetIconTooltipMarkup.

clearEntrySecondaryIconTooltipMarkup :: (MonadIO m, IsEntry o) => o -> m () Source #

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

clear #secondaryIconTooltipMarkup

constructEntrySecondaryIconTooltipMarkup :: (IsEntry o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getEntrySecondaryIconTooltipMarkup :: (MonadIO m, IsEntry o) => o -> m (Maybe Text) Source #

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

get entry #secondaryIconTooltipMarkup

setEntrySecondaryIconTooltipMarkup :: (MonadIO m, IsEntry o) => o -> Text -> m () Source #

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

set entry [ #secondaryIconTooltipMarkup := value ]

secondaryIconTooltipText

The contents of the tooltip on the secondary icon.

Also see entrySetIconTooltipText.

clearEntrySecondaryIconTooltipText :: (MonadIO m, IsEntry o) => o -> m () Source #

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

clear #secondaryIconTooltipText

constructEntrySecondaryIconTooltipText :: (IsEntry o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getEntrySecondaryIconTooltipText :: (MonadIO m, IsEntry o) => o -> m (Maybe Text) Source #

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

get entry #secondaryIconTooltipText

setEntrySecondaryIconTooltipText :: (MonadIO m, IsEntry o) => o -> Text -> m () Source #

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

set entry [ #secondaryIconTooltipText := value ]

showEmojiIcon

No description available in the introspection data.

constructEntryShowEmojiIcon :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getEntryShowEmojiIcon :: (MonadIO m, IsEntry o) => o -> m Bool Source #

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

get entry #showEmojiIcon

setEntryShowEmojiIcon :: (MonadIO m, IsEntry o) => o -> Bool -> m () Source #

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

set entry [ #showEmojiIcon := value ]

tabs

No description available in the introspection data.

clearEntryTabs :: (MonadIO m, IsEntry o) => o -> m () Source #

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

clear #tabs

constructEntryTabs :: (IsEntry o, MonadIO m) => TabArray -> m (GValueConstruct o) Source #

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

getEntryTabs :: (MonadIO m, IsEntry o) => o -> m (Maybe TabArray) Source #

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

get entry #tabs

setEntryTabs :: (MonadIO m, IsEntry o) => o -> TabArray -> m () Source #

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

set entry [ #tabs := value ]

textLength

The length of the text in the GtkEntry.

getEntryTextLength :: (MonadIO m, IsEntry o) => o -> m Word32 Source #

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

get entry #textLength

truncateMultiline

When True, pasted multi-line text is truncated to the first line.

constructEntryTruncateMultiline :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getEntryTruncateMultiline :: (MonadIO m, IsEntry o) => o -> m Bool Source #

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

get entry #truncateMultiline

setEntryTruncateMultiline :: (MonadIO m, IsEntry o) => o -> Bool -> m () Source #

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

set entry [ #truncateMultiline := value ]

visibility

Whether the entry should show the “invisible char” instead of the actual text (“password mode”).

constructEntryVisibility :: (IsEntry o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getEntryVisibility :: (MonadIO m, IsEntry o) => o -> m Bool Source #

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

get entry #visibility

setEntryVisibility :: (MonadIO m, IsEntry o) => o -> Bool -> m () Source #

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

set entry [ #visibility := value ]

Signals

activate

type EntryActivateCallback = IO () Source #

Emitted when the entry is activated.

The keybindings for this signal are all forms of the Enter key.

afterEntryActivate :: (IsEntry a, MonadIO m) => a -> ((?self :: a) => EntryActivateCallback) -> m SignalHandlerId Source #

Connect a signal handler for the activate signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after entry #activate callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onEntryActivate :: (IsEntry a, MonadIO m) => a -> ((?self :: a) => EntryActivateCallback) -> m SignalHandlerId Source #

Connect a signal handler for the activate signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on entry #activate callback

iconPress

type EntryIconPressCallback Source #

Arguments

= EntryIconPosition	`iconPos`: The position of the clicked icon
-> IO ()

Emitted when an activatable icon is clicked.

afterEntryIconPress :: (IsEntry a, MonadIO m) => a -> ((?self :: a) => EntryIconPressCallback) -> m SignalHandlerId Source #

Connect a signal handler for the iconPress signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after entry #iconPress callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onEntryIconPress :: (IsEntry a, MonadIO m) => a -> ((?self :: a) => EntryIconPressCallback) -> m SignalHandlerId Source #

Connect a signal handler for the iconPress signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on entry #iconPress callback

iconRelease

type EntryIconReleaseCallback Source #

Arguments

= EntryIconPosition	`iconPos`: The position of the clicked icon
-> IO ()

Emitted on the button release from a mouse click over an activatable icon.

afterEntryIconRelease :: (IsEntry a, MonadIO m) => a -> ((?self :: a) => EntryIconReleaseCallback) -> m SignalHandlerId Source #

Connect a signal handler for the iconRelease signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after entry #iconRelease callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onEntryIconRelease :: (IsEntry a, MonadIO m) => a -> ((?self :: a) => EntryIconReleaseCallback) -> m SignalHandlerId Source #

Connect a signal handler for the iconRelease signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on entry #iconRelease callback

CSS nodes

GtkEntry as GtkBuildable

xml code

Accessibility

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

getActivatesDefault

getAlignment

getAttributes

getBuffer

getCompletion

getCurrentIconDragSource

getExtraMenu

getHasFrame

getIconActivatable

getIconArea

getIconAtPos

getIconGicon

getIconName

getIconPaintable

getIconSensitive

getIconStorageType

getIconTooltipMarkup

getIconTooltipText

getInputHints

getInputPurpose

getInvisibleChar

getMaxLength

getOverwriteMode

getPlaceholderText

getProgressFraction

getProgressPulseStep

getTabs

getTextLength

getVisibility

grabFocusWithoutSelecting

new

newWithBuffer

progressPulse

resetImContext

setActivatesDefault

setAlignment

setAttributes

setBuffer

setCompletion

setExtraMenu

setHasFrame

setIconActivatable

setIconDragSource

setIconFromGicon

setIconFromIconName

setIconFromPaintable

setIconSensitive

setIconTooltipMarkup

setIconTooltipText

setInputHints

setInputPurpose

setInvisibleChar

setMaxLength

setOverwriteMode

setPlaceholderText

setProgressFraction

setProgressPulseStep

setTabs

setVisibility

unsetInvisibleChar

Properties

activatesDefault

attributes

buffer

completion

enableEmojiCompletion

extraMenu

hasFrame