Entry

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 [method@Gtk.Entry.set_visibility]. 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 [method@Gtk.Entry.set_invisible_char].

GtkEntry has the ability to display progress or activity information behind the text. To make an entry display such information, use [method@Gtk.Entry.set_progress_fraction] or [method@Gtk.Entry.set_progress_pulse_step].

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 [method@Gtk.Entry.set_icon_from_gicon] 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 [signal@Gtk.Entry::icon-press] signal. To allow DND operations from an icon, use [method@Gtk.Entry.set_icon_drag_source]. To set a tooltip on an icon, use [method@Gtk.Entry.set_icon_tooltip_text] 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 [class@Gtk.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:

<object class="GtkEnry">
<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 %GTK_ACCESSIBLE_ROLE_TEXT_BOX role.

class Entry : Widget , CellEditableIF , EditableIF {}

Constructors

this
this(GtkEntry* gtkEntry, bool ownedRef)

Sets our main struct and passes it to the parent class.

this
this()

Creates a new entry.

this
this(EntryBuffer buffer)

Creates a new entry with the specified text buffer.

Members

Functions

addOnActivate
gulong addOnActivate(void delegate(Entry) dlg, ConnectFlags connectFlags)

Emitted when the entry is activated.

addOnIconPress
gulong addOnIconPress(void delegate(GtkEntryIconPosition, Entry) dlg, ConnectFlags connectFlags)

Emitted when an activatable icon is clicked.

addOnIconRelease
gulong addOnIconRelease(void delegate(GtkEntryIconPosition, Entry) dlg, ConnectFlags connectFlags)

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

getActivatesDefault
bool getActivatesDefault()

Retrieves the value set by gtk_entry_set_activates_default().

getAlignment
float getAlignment()

Gets the value set by gtk_entry_set_alignment().

getAttributes
PgAttributeList getAttributes()

Gets the attribute list of the GtkEntry.

getBuffer
EntryBuffer getBuffer()

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

getCompletion
EntryCompletion getCompletion()

Returns the auxiliary completion object currently in use by @entry.

getCurrentIconDragSource
int getCurrentIconDragSource()

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

getEntryStruct
GtkEntry* getEntryStruct(bool transferOwnership)

Get the main Gtk struct

getExtraMenu
MenuModel getExtraMenu()

Gets the menu model set with gtk_entry_set_extra_menu().

getHasFrame
bool getHasFrame()

Gets the value set by gtk_entry_set_has_frame().

getIconActivatable
bool getIconActivatable(GtkEntryIconPosition iconPos)

Returns whether the icon is activatable.

getIconArea
void getIconArea(GtkEntryIconPosition iconPos, GdkRectangle iconArea)

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

getIconAtPos
int getIconAtPos(int x, int y)

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

getIconGicon
IconIF getIconGicon(GtkEntryIconPosition iconPos)

Retrieves the GIcon used for the icon.

getIconName
string getIconName(GtkEntryIconPosition iconPos)

Retrieves the icon name used for the icon.

getIconPaintable
PaintableIF getIconPaintable(GtkEntryIconPosition iconPos)

Retrieves the GdkPaintable used for the icon.

getIconSensitive
bool getIconSensitive(GtkEntryIconPosition iconPos)

Returns whether the icon appears sensitive or insensitive.

getIconStorageType
GtkImageType getIconStorageType(GtkEntryIconPosition iconPos)

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

getIconTooltipMarkup
string getIconTooltipMarkup(GtkEntryIconPosition iconPos)

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

getIconTooltipText
string getIconTooltipText(GtkEntryIconPosition iconPos)

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

getInputHints
GtkInputHints getInputHints()

Gets the input hints of this GtkEntry.

getInputPurpose
GtkInputPurpose getInputPurpose()

Gets the input purpose of the GtkEntry.

getInvisibleChar
dchar getInvisibleChar()

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

getMaxLength
int getMaxLength()

Retrieves the maximum allowed length of the text in @entry.

getOverwriteMode
bool getOverwriteMode()

Gets whether the GtkEntry is in overwrite mode.

getPlaceholderText
string getPlaceholderText()

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

getProgressFraction
double getProgressFraction()

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

getProgressPulseStep
double getProgressPulseStep()

Retrieves the pulse step set with gtk_entry_set_progress_pulse_step().

getStruct
void* getStruct()

the main Gtk struct as a void*

getTabs
PgTabArray getTabs()

Gets the tabstops of the `GtkEntry.

getTextLength
ushort getTextLength()

Retrieves the current length of the text in @entry.

getVisibility
bool getVisibility()

Retrieves whether the text in @entry is visible.

grabFocusWithoutSelecting
bool grabFocusWithoutSelecting()

Causes @entry to have keyboard focus.

progressPulse
void progressPulse()

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

resetImContext
void resetImContext()

Reset the input method context of the entry if needed.

setActivatesDefault
void setActivatesDefault(bool setting)

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

setAlignment
void setAlignment(float xalign)

Sets the alignment for the contents of the entry.

setAttributes
void setAttributes(PgAttributeList attrs)

Sets a PangoAttrList.

setBuffer
void setBuffer(EntryBuffer buffer)

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

setCompletion
void setCompletion(EntryCompletion completion)

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

setExtraMenu
void setExtraMenu(MenuModel model)

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

setHasFrame
void setHasFrame(bool setting)

Sets whether the entry has a beveled frame around it.

setIconActivatable
void setIconActivatable(GtkEntryIconPosition iconPos, bool activatable)

Sets whether the icon is activatable.

setIconDragSource
void setIconDragSource(GtkEntryIconPosition iconPos, ContentProvider provider, GdkDragAction actions)

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

setIconFromGicon
void setIconFromGicon(GtkEntryIconPosition iconPos, IconIF icon)

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

setIconFromIconName
void setIconFromIconName(GtkEntryIconPosition iconPos, string iconName)

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

setIconFromPaintable
void setIconFromPaintable(GtkEntryIconPosition iconPos, PaintableIF paintable)

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

setIconSensitive
void setIconSensitive(GtkEntryIconPosition iconPos, bool sensitive)

Sets the sensitivity for the specified icon.

setIconTooltipMarkup
void setIconTooltipMarkup(GtkEntryIconPosition iconPos, string tooltip)

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

setIconTooltipText
void setIconTooltipText(GtkEntryIconPosition iconPos, string tooltip)

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

setInputHints
void setInputHints(GtkInputHints hints)

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

setInputPurpose
void setInputPurpose(GtkInputPurpose purpose)

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

setInvisibleChar
void setInvisibleChar(dchar ch)

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

setMaxLength
void setMaxLength(int max)

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

setOverwriteMode
void setOverwriteMode(bool overwrite)

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

setPlaceholderText
void setPlaceholderText(string text)

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

setProgressFraction
void setProgressFraction(double fraction)

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

setProgressPulseStep
void setProgressPulseStep(double fraction)

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

setTabs
void setTabs(PgTabArray tabs)

Sets a PangoTabArray.

setVisibility
void setVisibility(bool visible)

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

unsetInvisibleChar
void unsetInvisibleChar()

Unsets the invisible char, so that the default invisible char is used again. See [method@Gtk.Entry.set_invisible_char].

Mixins

__anonymous
mixin CellEditableT!(GtkEntry)
Undocumented in source.
__anonymous
mixin EditableT!(GtkEntry)
Undocumented in source.

Static functions

getType
GType getType()

Variables

gtkEntry
GtkEntry* gtkEntry;

the main Gtk struct

Inherited Members

From Widget

gtkWidget
GtkWidget* gtkWidget;

the main Gtk struct

getWidgetStruct
GtkWidget* getWidgetStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

__anonymous
mixin AccessibleT!(GtkWidget)
Undocumented in source.
__anonymous
mixin BuildableT!(GtkWidget)
Undocumented in source.
__anonymous
mixin ConstraintTargetT!(GtkWidget)
Undocumented in source.
getType
GType getType()
getDefaultDirection
GtkTextDirection getDefaultDirection()

Obtains the current default reading direction.

setDefaultDirection
void setDefaultDirection(GtkTextDirection dir)

Sets the default reading direction for widgets.

actionSetEnabled
void actionSetEnabled(string actionName, bool enabled)

Enable or disable an action installed with gtk_widget_class_install_action().

activate
bool activate()

For widgets that can be “activated” (buttons, menu items, etc.) this function activates them.

activateActionVariant
bool activateActionVariant(string name, Variant args)

Looks up the action in the action groups associated with @widget and its ancestors, and activates it.

activateDefault
void activateDefault()

Activates the default.activate action from @widget.

addController
void addController(EventController controller)

Adds @controller to @widget so that it will receive events.

addCssClass
void addCssClass(string cssClass)

Adds a style class to @widget.

addMnemonicLabel
void addMnemonicLabel(Widget label)

Adds a widget to the list of mnemonic labels for this widget.

addTickCallback
uint addTickCallback(GtkTickCallback callback, void* userData, GDestroyNotify notify)

Queues an animation frame update and adds a callback to be called before each frame.

allocate
void allocate(int width, int height, int baseline, Transform transform)

This function is only used by GtkWidget subclasses, to assign a size, position and (optionally) baseline to their child widgets.

childFocus
bool childFocus(GtkDirectionType direction)

Called by widgets as the user moves around the window using keyboard shortcuts.

computeBounds
bool computeBounds(Widget target, Rect outBounds)

Computes the bounds for @widget in the coordinate space of @target.

computeExpand
bool computeExpand(GtkOrientation orientation)

Computes whether a container should give this widget extra space when possible.

computePoint
bool computePoint(Widget target, Point point, Point outPoint)

Translates the given @point in @widget's coordinates to coordinates relative to @target’s coordinate system.

computeTransform
bool computeTransform(Widget target, Matrix outTransform)

Computes a matrix suitable to describe a transformation from @widget's coordinate system into @target's coordinate system.

contains
bool contains(double x, double y)

Tests if the point at (@x, @y) is contained in @widget.

createPangoContext
PgContext createPangoContext()

Creates a new PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget.

createPangoLayout
PgLayout createPangoLayout(string text)

Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.

dragCheckThreshold
bool dragCheckThreshold(int startX, int startY, int currentX, int currentY)

Checks to see if a drag movement has passed the GTK drag threshold.

errorBell
void errorBell()

Notifies the user about an input-related error on this widget.

getAllocatedBaseline
int getAllocatedBaseline()

Returns the baseline that has currently been allocated to @widget.

getAllocatedHeight
int getAllocatedHeight()

Returns the height that has currently been allocated to @widget.

getAllocatedWidth
int getAllocatedWidth()

Returns the width that has currently been allocated to @widget.

getAllocation
void getAllocation(GtkAllocation allocation)

Retrieves the widget’s allocation.

getAncestor
Widget getAncestor(GType widgetType)

Gets the first ancestor of @widget with type @widget_type.

getCanFocus
bool getCanFocus()

Determines whether the input focus can enter @widget or any of its children.

getCanTarget
bool getCanTarget()

Queries whether @widget can be the target of pointer events.

getChildVisible
bool getChildVisible()

Gets the value set with gtk_widget_set_child_visible().

getClipboard
Clipboard getClipboard()

Gets the clipboard object for @widget.

getCssClasses
string[] getCssClasses()

Returns the list of style classes applied to @widget.

getCssName
string getCssName()

Returns the CSS name that is used for @self.

getCursor
Cursor getCursor()

Queries the cursor set on @widget.

getDirection
GtkTextDirection getDirection()

Gets the reading direction for a particular widget.

getDisplay
Display getDisplay()

Get the GdkDisplay for the toplevel window associated with this widget.

getFirstChild
Widget getFirstChild()

Returns the widgets first child.

getFocusChild
Widget getFocusChild()

Returns the current focus child of @widget.

getFocusOnClick
bool getFocusOnClick()

Returns whether the widget should grab focus when it is clicked with the mouse.

getFocusable
bool getFocusable()

Determines whether @widget can own the input focus.

getFontMap
PgFontMap getFontMap()

Gets the font map of @widget.

getFontOptions
FontOption getFontOptions()

Returns the cairo_font_options_t used for Pango rendering.

getFrameClock
FrameClock getFrameClock()

Obtains the frame clock for a widget.

getHalign
GtkAlign getHalign()

Gets the horizontal alignment of @widget.

getHasTooltip
bool getHasTooltip()

Returns the current value of the has-tooltip property.

getHeight
int getHeight()

Returns the content height of the widget.

getHexpand
bool getHexpand()

Gets whether the widget would like any available extra horizontal space.

getHexpandSet
bool getHexpandSet()

Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget.

getLastChild
Widget getLastChild()

Returns the widgets last child.

getLayoutManager
LayoutManager getLayoutManager()

Retrieves the layout manager used by @widget

getMapped
bool getMapped()

Whether the widget is mapped.

getMarginBottom
int getMarginBottom()

Gets the bottom margin of @widget.

getMarginEnd
int getMarginEnd()

Gets the end margin of @widget.

getMarginStart
int getMarginStart()

Gets the start margin of @widget.

getMarginTop
int getMarginTop()

Gets the top margin of @widget.

getName
string getName()

Retrieves the name of a widget.

getNative
NativeIF getNative()

Returns the GtkNative widget that contains @widget.

getNextSibling
Widget getNextSibling()

Returns the widgets next sibling.

getOpacity
double getOpacity()

#Fetches the requested opacity for this widget.

getOverflow
GtkOverflow getOverflow()

Returns the widgets overflow value.

getPangoContext
PgContext getPangoContext()

Gets a PangoContext with the appropriate font map, font description, and base direction for this widget.

getParent
Widget getParent()

Returns the parent widget of @widget.

getPreferredSize
void getPreferredSize(Requisition minimumSize, Requisition naturalSize)

Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.

getPrevSibling
Widget getPrevSibling()

Returns the widgets previous sibling.

getPrimaryClipboard
Clipboard getPrimaryClipboard()

Gets the primary clipboard of @widget.

getRealized
bool getRealized()

Determines whether @widget is realized.

getReceivesDefault
bool getReceivesDefault()

Determines whether @widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default.

getRequestMode
GtkSizeRequestMode getRequestMode()

Gets whether the widget prefers a height-for-width layout or a width-for-height layout.

getRoot
RootIF getRoot()

Returns the GtkRoot widget of @widget.

getScaleFactor
int getScaleFactor()

Retrieves the internal scale factor that maps from window coordinates to the actual device pixels.

getSensitive
bool getSensitive()

Returns the widget’s sensitivity.

getSettings
Settings getSettings()

Gets the settings object holding the settings used for this widget.

getSize
int getSize(GtkOrientation orientation)

Returns the content width or height of the widget.

getSizeRequest
void getSizeRequest(int width, int height)

Gets the size request that was explicitly set for the widget using gtk_widget_set_size_request().

getStateFlags
GtkStateFlags getStateFlags()

Returns the widget state as a flag set.

getStyleContext
StyleContext getStyleContext()

Returns the style context associated to @widget.

getTemplateChild
ObjectG getTemplateChild(GType widgetType, string name)

Fetch an object build from the template XML for @widget_type in this @widget instance.

getTooltipMarkup
string getTooltipMarkup()

Gets the contents of the tooltip for @widget.

getTooltipText
string getTooltipText()

Gets the contents of the tooltip for @widget.

getValign
GtkAlign getValign()

Gets the vertical alignment of @widget.

getVexpand
bool getVexpand()

Gets whether the widget would like any available extra vertical space.

getVexpandSet
bool getVexpandSet()

Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget.

getVisible
bool getVisible()

Determines whether the widget is visible.

getWidth
int getWidth()

Returns the content width of the widget.

grabFocus
bool grabFocus()

Causes @widget to have the keyboard focus for the GtkWindow it's inside.

hasCssClass
bool hasCssClass(string cssClass)

Returns whether @css_class is currently applied to @widget.

hasDefault
bool hasDefault()

Determines whether @widget is the current default widget within its toplevel.

hasFocus
bool hasFocus()

Determines if the widget has the global input focus.

hasVisibleFocus
bool hasVisibleFocus()

Determines if the widget should show a visible indication that it has the global input focus.

hide
void hide()

Reverses the effects of gtk_widget_show().

inDestruction
bool inDestruction()

Returns whether the widget is currently being destroyed.

initTemplate
void initTemplate()

Creates and initializes child widgets defined in templates.

insertActionGroup
void insertActionGroup(string name, ActionGroupIF group)

Inserts @group into @widget.

insertAfter
void insertAfter(Widget parent, Widget previousSibling)

Inserts @widget into the child widget list of @parent.

insertBefore
void insertBefore(Widget parent, Widget nextSibling)

Inserts @widget into the child widget list of @parent.

isAncestor
bool isAncestor(Widget ancestor)

Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers.

isDrawable
bool isDrawable()

Determines whether @widget can be drawn to.

isFocus
bool isFocus()

Determines if the widget is the focus widget within its toplevel.

isSensitive
bool isSensitive()

Returns the widget’s effective sensitivity.

isVisible
bool isVisible()

Determines whether the widget and all its parents are marked as visible.

keynavFailed
bool keynavFailed(GtkDirectionType direction)

Emits the ::keynav-failed signal on the widget.

listMnemonicLabels
ListG listMnemonicLabels()

Returns the widgets for which this widget is the target of a mnemonic.

map
void map()

Causes a widget to be mapped if it isn’t already.

measure
void measure(GtkOrientation orientation, int forSize, int minimum, int natural, int minimumBaseline, int naturalBaseline)

Measures @widget in the orientation @orientation and for the given @for_size.

mnemonicActivate
bool mnemonicActivate(bool groupCycling)

Emits the GtkWidget::mnemonic-activate signal.

observeChildren
ListModelIF observeChildren()

Returns a GListModel to track the children of @widget.

observeControllers
ListModelIF observeControllers()

Returns a GListModel to track the [class@Gtk.EventController]s of @widget.

pick
Widget pick(double x, double y, GtkPickFlags flags)

Finds the descendant of @widget closest to the screen at the point (@x, @y).

queueAllocate
void queueAllocate()

Flags the widget for a rerun of the GtkWidgetClass::size_allocate function.

queueDraw
void queueDraw()

Schedules this widget to be redrawn in paint phase of the current or the next frame.

queueResize
void queueResize()

Flags a widget to have its size renegotiated.

realize
void realize()

Creates the GDK resources associated with a widget.

removeController
void removeController(EventController controller)

Removes @controller from @widget, so that it doesn't process events anymore.

removeCssClass
void removeCssClass(string cssClass)

Removes a style from @widget.

removeMnemonicLabel
void removeMnemonicLabel(Widget label)

Removes a widget from the list of mnemonic labels for this widget.

removeTickCallback
void removeTickCallback(uint id)

Removes a tick callback previously registered with gtk_widget_add_tick_callback().

setCanFocus
void setCanFocus(bool canFocus)

Specifies whether the input focus can enter the widget or any of its children.

setCanTarget
void setCanTarget(bool canTarget)

Sets whether @widget can be the target of pointer events.

setChildVisible
void setChildVisible(bool childVisible)

Sets whether @widget should be mapped along with its parent.

setCssClasses
void setCssClasses(string[] classes)

Will clear all style classes applied to @widget and replace them with @classes.

setCursor
void setCursor(Cursor cursor)

Sets the cursor to be shown when pointer devices point towards @widget.

setCursorFromName
void setCursorFromName(string name)

Sets a named cursor to be shown when pointer devices point towards @widget.

setDirection
void setDirection(GtkTextDirection dir)

Sets the reading direction on a particular widget.

setFocusChild
void setFocusChild(Widget child)

Set @child as the current focus child of @widget.

setFocusOnClick
void setFocusOnClick(bool focusOnClick)

Sets whether the widget should grab focus when it is clicked with the mouse.

setFocusable
void setFocusable(bool focusable)

Specifies whether @widget can own the input focus.

setFontMap
void setFontMap(PgFontMap fontMap)

Sets the font map to use for Pango rendering.

setFontOptions
void setFontOptions(FontOption options)

Sets the cairo_font_options_t used for Pango rendering in this widget.

setHalign
void setHalign(GtkAlign align_)

Sets the horizontal alignment of @widget.

setHasTooltip
void setHasTooltip(bool hasTooltip)

Sets the has-tooltip property on @widget to @has_tooltip.

setHexpand
void setHexpand(bool expand)

Sets whether the widget would like any available extra horizontal space.

setHexpandSet
void setHexpandSet(bool set)

Sets whether the hexpand flag will be used.

setLayoutManager
void setLayoutManager(LayoutManager layoutManager)

Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of @widget.

setMarginBottom
void setMarginBottom(int margin)

Sets the bottom margin of @widget.

setMarginEnd
void setMarginEnd(int margin)

Sets the end margin of @widget.

setMarginStart
void setMarginStart(int margin)

Sets the start margin of @widget.

setMarginTop
void setMarginTop(int margin)

Sets the top margin of @widget.

setName
void setName(string name)

Sets a widgets name.

setOpacity
void setOpacity(double opacity)

Request the @widget to be rendered partially transparent.

setOverflow
void setOverflow(GtkOverflow overflow)

Sets how @widget treats content that is drawn outside the widget's content area.

setParent
void setParent(Widget parent)

Sets @parent as the parent widget of @widget.

setReceivesDefault
void setReceivesDefault(bool receivesDefault)

Specifies whether @widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default.

setSensitive
void setSensitive(bool sensitive)

Sets the sensitivity of a widget.

setSizeRequest
void setSizeRequest(int width, int height)

Sets the minimum size of a widget.

setStateFlags
void setStateFlags(GtkStateFlags flags, bool clear)

Turns on flag values in the current widget state.

setTooltipMarkup
void setTooltipMarkup(string markup)

Sets @markup as the contents of the tooltip, which is marked up with Pango markup.

setTooltipText
void setTooltipText(string text)

Sets @text as the contents of the tooltip.

setValign
void setValign(GtkAlign align_)

Sets the vertical alignment of @widget.

setVexpand
void setVexpand(bool expand)

Sets whether the widget would like any available extra vertical space.

setVexpandSet
void setVexpandSet(bool set)

Sets whether the vexpand flag will be used.

setVisible
void setVisible(bool visible)

Sets the visibility state of @widget.

shouldLayout
bool shouldLayout()

Returns whether @widget should contribute to the measuring and allocation of its parent.

show
void show()

Flags a widget to be displayed.

sizeAllocate
void sizeAllocate(GtkAllocation* allocation, int baseline)

Allocates widget with a transformation that translates the origin to the position in @allocation.

snapshotChild
void snapshotChild(Widget child, Snapshot snapshot)

Snapshot the a child of @widget.

translateCoordinates
bool translateCoordinates(Widget destWidget, double srcX, double srcY, double destX, double destY)

Translate coordinates relative to @src_widget’s allocation to coordinates relative to @dest_widget’s allocations.

triggerTooltipQuery
void triggerTooltipQuery()

Triggers a tooltip query on the display where the toplevel of @widget is located.

unmap
void unmap()

Causes a widget to be unmapped if it’s currently mapped.

unparent
void unparent()

Dissociate @widget from its parent.

unrealize
void unrealize()

Causes a widget to be unrealized (frees all GDK resources associated with the widget).

unsetStateFlags
void unsetStateFlags(GtkStateFlags flags)

Turns off flag values for the current widget state.

addOnDestroy
gulong addOnDestroy(void delegate(Widget) dlg, ConnectFlags connectFlags)

Signals that all holders of a reference to the widget should release the reference that they hold.

addOnDirectionChanged
gulong addOnDirectionChanged(void delegate(GtkTextDirection, Widget) dlg, ConnectFlags connectFlags)

Emitted when the text direction of a widget changes.

addOnHide
gulong addOnHide(void delegate(Widget) dlg, ConnectFlags connectFlags)

Emitted when @widget is hidden.

addOnKeynavFailed
gulong addOnKeynavFailed(bool delegate(GtkDirectionType, Widget) dlg, ConnectFlags connectFlags)

Emitted if keyboard navigation fails.

addOnMap
gulong addOnMap(void delegate(Widget) dlg, ConnectFlags connectFlags)

Emitted when @widget is going to be mapped.

addOnMnemonicActivate
gulong addOnMnemonicActivate(bool delegate(bool, Widget) dlg, ConnectFlags connectFlags)

Emitted when a widget is activated via a mnemonic.

addOnMoveFocus
gulong addOnMoveFocus(void delegate(GtkDirectionType, Widget) dlg, ConnectFlags connectFlags)

Emitted when the focus is moved.

addOnQueryTooltip
gulong addOnQueryTooltip(bool delegate(int, int, bool, Tooltip, Widget) dlg, ConnectFlags connectFlags)

Emitted when the widgets tooltip is about to be shown.

addOnRealize
gulong addOnRealize(void delegate(Widget) dlg, ConnectFlags connectFlags)

Emitted when @widget is associated with a GdkSurface.

addOnShow
gulong addOnShow(void delegate(Widget) dlg, ConnectFlags connectFlags)

Emitted when @widget is shown.

addOnStateFlagsChanged
gulong addOnStateFlagsChanged(void delegate(GtkStateFlags, Widget) dlg, ConnectFlags connectFlags)

Emitted when the widget state changes.

addOnUnmap
gulong addOnUnmap(void delegate(Widget) dlg, ConnectFlags connectFlags)

Emitted when @widget is going to be unmapped.

addOnUnrealize
gulong addOnUnrealize(void delegate(Widget) dlg, ConnectFlags connectFlags)

Emitted when the GdkSurface associated with @widget is destroyed.

From CellEditableIF

getCellEditableStruct
GtkCellEditable* getCellEditableStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
editingDone
void editingDone()

Emits the #GtkCellEditable::editing-done signal.

removeWidget
void removeWidget()

Emits the #GtkCellEditable::remove-widget signal.

startEditing
void startEditing(Event event)

Begins editing on a @cell_editable.

addOnEditingDone
gulong addOnEditingDone(void delegate(CellEditableIF) dlg, ConnectFlags connectFlags)

This signal is a sign for the cell renderer to update its value from the @cell_editable.

addOnRemoveWidget
gulong addOnRemoveWidget(void delegate(CellEditableIF) dlg, ConnectFlags connectFlags)

This signal is meant to indicate that the cell is finished editing, and the @cell_editable widget is being removed and may subsequently be destroyed.

From EditableIF

getEditableStruct
GtkEditable* getEditableStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getType
GType getType()
delegateGetProperty
bool delegateGetProperty(ObjectG object, uint propId, Value value, ParamSpec pspec)

Gets a property of the GtkEditable delegate for @object.

delegateSetProperty
bool delegateSetProperty(ObjectG object, uint propId, Value value, ParamSpec pspec)

Sets a property on the GtkEditable delegate for @object.

installProperties
uint installProperties(ObjectClass objectClass, uint firstProp)

Installs the GtkEditable properties for @class.

deleteSelection
void deleteSelection()

Deletes the currently selected text of the editable.

deleteText
void deleteText(int startPos, int endPos)

Deletes a sequence of characters.

finishDelegate
void finishDelegate()

Undoes the setup done by [method@Gtk.Editable.init_delegate].

getAlignment
float getAlignment()

Gets the alignment of the editable.

getChars
string getChars(int startPos, int endPos)

Retrieves a sequence of characters.

getDelegate
EditableIF getDelegate()

Gets the GtkEditable that @editable is delegating its implementation to.

getEditable
bool getEditable()

Retrieves whether @editable is editable.

getEnableUndo
bool getEnableUndo()

Gets if undo/redo actions are enabled for @editable

getMaxWidthChars
int getMaxWidthChars()

Retrieves the desired maximum width of @editable, in characters.

getPosition
int getPosition()

Retrieves the current position of the cursor relative to the start of the content of the editable.

getSelectionBounds
bool getSelectionBounds(int startPos, int endPos)

Retrieves the selection bound of the editable.

getText
string getText()

Retrieves the contents of @editable.

getWidthChars
int getWidthChars()

Gets the number of characters of space reserved for the contents of the editable.

initDelegate
void initDelegate()

Sets up a delegate for GtkEditable.

insertText
void insertText(string text, int length, int position)

Inserts @length bytes of @text into the contents of the widget, at position @position.

selectRegion
void selectRegion(int startPos, int endPos)

Selects a region of text.

setAlignment
void setAlignment(float xalign)

Sets the alignment for the contents of the editable.

setEditable
void setEditable(bool isEditable)

Determines if the user can edit the text in the editable widget.

setEnableUndo
void setEnableUndo(bool enableUndo)

If enabled, changes to @editable will be saved for undo/redo actions.

setMaxWidthChars
void setMaxWidthChars(int nChars)

Sets the desired maximum width in characters of @editable.

setPosition
void setPosition(int position)

Sets the cursor position in the editable to the given value.

setText
void setText(string text)

Sets the text in the editable to the given value.

setWidthChars
void setWidthChars(int nChars)

Changes the size request of the editable to be about the right size for @n_chars characters.

addOnChanged
gulong addOnChanged(void delegate(EditableIF) dlg, ConnectFlags connectFlags)

Emitted at the end of a single user-visible operation on the contents.

addOnDeleteText
gulong addOnDeleteText(void delegate(int, int, EditableIF) dlg, ConnectFlags connectFlags)

Emitted when text is deleted from the widget by the user.

addOnInsertText
gulong addOnInsertText(void delegate(string, int, void*, EditableIF) dlg, ConnectFlags connectFlags)

Emitted when text is inserted into the widget by the user.

Meta