IconView

gtk.icon_view.IconView is a widget which displays data in a grid of icons.

gtk.icon_view.IconView provides an alternative view on a gtk.tree_model.TreeModel. It displays the model as a grid of icons with labels. Like gtk.tree_view.TreeView, it allows to select one or multiple items (depending on the selection mode, see gtk.icon_view.IconView.setSelectionMode). In addition to selection with the arrow keys, gtk.icon_view.IconView supports rubberband selection, which is controlled by dragging the pointer.

Note that if the tree model is backed by an actual tree store (as opposed to a flat list where the mapping to icons is obvious), gtk.icon_view.IconView will only display the first level of the tree and ignore the tree’s branches.

CSS nodes

iconview.view
╰── [rubberband]

gtk.icon_view.IconView has a single CSS node with name iconview and style class .view. For rubberband selection, a subnode with name rubberband is used.

More...
class IconView : Widget , CellLayout , Scrollable {}

Constructors

this
this()

Creates a new gtk.icon_view.IconView widget

Members

Functions

connectActivateCursorItem
ulong connectActivateCursorItem(T callback, Flag!"After" after)

Connect to ActivateCursorItem signal.

connectItemActivated
ulong connectItemActivated(T callback, Flag!"After" after)

Connect to ItemActivated signal.

connectMoveCursor
ulong connectMoveCursor(T callback, Flag!"After" after)

Connect to MoveCursor signal.

connectSelectAll
ulong connectSelectAll(T callback, Flag!"After" after)

Connect to SelectAll signal.

connectSelectCursorItem
ulong connectSelectCursorItem(T callback, Flag!"After" after)

Connect to SelectCursorItem signal.

connectSelectionChanged
ulong connectSelectionChanged(T callback, Flag!"After" after)

Connect to SelectionChanged signal.

connectToggleCursorItem
ulong connectToggleCursorItem(T callback, Flag!"After" after)

Connect to ToggleCursorItem signal.

connectUnselectAll
ulong connectUnselectAll(T callback, Flag!"After" after)

Connect to UnselectAll signal.

createDragIcon
gdk.paintable.Paintable createDragIcon(gtk.tree_path.TreePath path)

Creates a gdk.paintable.Paintable representation of the item at path. This image is used for a drag icon.

enableModelDragDest
void enableModelDragDest(gdk.content_formats.ContentFormats formats, gdk.types.DragAction actions)

Turns icon_view into a drop destination for automatic DND. Calling this method sets gtk.icon_view.IconView:reorderable to false.

enableModelDragSource
void enableModelDragSource(gdk.types.ModifierType startButtonMask, gdk.content_formats.ContentFormats formats, gdk.types.DragAction actions)

Turns icon_view into a drag source for automatic DND. Calling this method sets gtk.icon_view.IconView:reorderable to false.

getActivateOnSingleClick
bool getActivateOnSingleClick()

Gets the setting set by gtk.icon_view.IconView.setActivateOnSingleClick.

getCellRect
bool getCellRect(gtk.tree_path.TreePath path, gtk.cell_renderer.CellRenderer cell, gdk.rectangle.Rectangle rect)

Fills the bounding rectangle in widget coordinates for the cell specified by path and cell. If cell is null the main cell area is used.

getColumnSpacing
int getColumnSpacing()

Returns the value of the ::column-spacing property.

getColumns
int getColumns()

Returns the value of the ::columns property.

getCursor
bool getCursor(gtk.tree_path.TreePath path, gtk.cell_renderer.CellRenderer cell)

Fills in path and cell with the current cursor path and cell. If the cursor isn’t currently set, then *path will be null. If no cell currently has focus, then *cell will be null.

getDestItemAtPos
bool getDestItemAtPos(int dragX, int dragY, gtk.tree_path.TreePath path, gtk.types.IconViewDropPosition pos)

Determines the destination item for a given position.

getDragDestItem
void getDragDestItem(gtk.tree_path.TreePath path, gtk.types.IconViewDropPosition pos)

Gets information about the item that is highlighted for feedback.

getItemAtPos
bool getItemAtPos(int x, int y, gtk.tree_path.TreePath path, gtk.cell_renderer.CellRenderer cell)

Gets the path and cell for the icon at the given position.

getItemColumn
int getItemColumn(gtk.tree_path.TreePath path)

Gets the column in which the item path is currently displayed. Column numbers start at 0.

getItemOrientation
gtk.types.Orientation getItemOrientation()

Returns the value of the ::item-orientation property which determines whether the labels are drawn beside the icons instead of below.

getItemPadding
int getItemPadding()

Returns the value of the ::item-padding property.

getItemRow
int getItemRow(gtk.tree_path.TreePath path)

Gets the row in which the item path is currently displayed. Row numbers start at 0.

getItemWidth
int getItemWidth()

Returns the value of the ::item-width property.

getMargin
int getMargin()

Returns the value of the ::margin property.

getMarkupColumn
int getMarkupColumn()

Returns the column with markup text for icon_view.

getModel
gtk.tree_model.TreeModel getModel()

Returns the model the gtk.icon_view.IconView is based on. Returns null if the model is unset.

getPathAtPos
gtk.tree_path.TreePath getPathAtPos(int x, int y)

Gets the path for the icon at the given position.

getPixbufColumn
int getPixbufColumn()

Returns the column with pixbufs for icon_view.

getReorderable
bool getReorderable()

Retrieves whether the user can reorder the list via drag-and-drop. See gtk.icon_view.IconView.setReorderable.

getRowSpacing
int getRowSpacing()

Returns the value of the ::row-spacing property.

getSelectedItems
gtk.tree_path.TreePath[] getSelectedItems()

Creates a list of paths of all selected items. Additionally, if you are planning on modifying the model after calling this function, you may want to convert the returned list into a list of GtkTreeRowReferences. To do this, you can use gtk.tree_row_reference.TreeRowReference.new_.

getSelectionMode
gtk.types.SelectionMode getSelectionMode()

Gets the selection mode of the icon_view.

getSpacing
int getSpacing()

Returns the value of the ::spacing property.

getTextColumn
int getTextColumn()

Returns the column with text for icon_view.

getTooltipColumn
int getTooltipColumn()

Returns the column of icon_view’s model which is being used for displaying tooltips on icon_view’s rows.

getTooltipContext
bool getTooltipContext(int x, int y, bool keyboardTip, gtk.tree_model.TreeModel model, gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter)

This function is supposed to be used in a GtkWidget::query-tooltip signal handler for gtk.icon_view.IconView. The x, y and keyboard_tip values which are received in the signal handler, should be passed to this function without modification.

getVisibleRange
bool getVisibleRange(gtk.tree_path.TreePath startPath, gtk.tree_path.TreePath endPath)

Sets start_path and end_path to be the first and last visible path. Note that there may be invisible paths in between.

itemActivated
void itemActivated(gtk.tree_path.TreePath path)

Activates the item determined by path.

pathIsSelected
bool pathIsSelected(gtk.tree_path.TreePath path)

Returns true if the icon pointed to by path is currently selected. If path does not point to a valid location, false is returned.

scrollToPath
void scrollToPath(gtk.tree_path.TreePath path, bool useAlign, float rowAlign, float colAlign)

Moves the alignments of icon_view to the position specified by path. row_align determines where the row is placed, and col_align determines where column is placed. Both are expected to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means right/bottom alignment, 0.5 means center.

selectAll
void selectAll()

Selects all the icons. icon_view must has its selection mode set to gtk.types.SelectionMode.Multiple.

selectPath
void selectPath(gtk.tree_path.TreePath path)

Selects the row at path.

selectedForeach
void selectedForeach(gtk.types.IconViewForeachFunc func)

Calls a function for each selected icon. Note that the model or selection cannot be modified from within this function.

setActivateOnSingleClick
void setActivateOnSingleClick(bool single)

Causes the gtk.icon_view.IconView::item-activated signal to be emitted on a single click instead of a double click.

setColumnSpacing
void setColumnSpacing(int columnSpacing)

Sets the ::column-spacing property which specifies the space which is inserted between the columns of the icon view.

setColumns
void setColumns(int columns)

Sets the ::columns property which determines in how many columns the icons are arranged. If columns is -1, the number of columns will be chosen automatically to fill the available area.

setCursor
void setCursor(gtk.tree_path.TreePath path, gtk.cell_renderer.CellRenderer cell, bool startEditing)

Sets the current keyboard focus to be at path, and selects it. This is useful when you want to focus the user’s attention on a particular item. If cell is not null, then focus is given to the cell specified by it. Additionally, if start_editing is true, then editing should be started in the specified cell.

setDragDestItem
void setDragDestItem(gtk.tree_path.TreePath path, gtk.types.IconViewDropPosition pos)

Sets the item that is highlighted for feedback.

setItemOrientation
void setItemOrientation(gtk.types.Orientation orientation)

Sets the ::item-orientation property which determines whether the labels are drawn beside the icons instead of below.

setItemPadding
void setItemPadding(int itemPadding)

Sets the gtk.icon_view.IconView:item-padding property which specifies the padding around each of the icon view’s items.

setItemWidth
void setItemWidth(int itemWidth)

Sets the ::item-width property which specifies the width to use for each item. If it is set to -1, the icon view will automatically determine a suitable item size.

setMargin
void setMargin(int margin)

Sets the ::margin property which specifies the space which is inserted at the top, bottom, left and right of the icon view.

setMarkupColumn
void setMarkupColumn(int column)

Sets the column with markup information for icon_view to be column. The markup column must be of type G_TYPE_STRING. If the markup column is set to something, it overrides the text column set by gtk.icon_view.IconView.setTextColumn.

setModel
void setModel(gtk.tree_model.TreeModel model)

Sets the model for a gtk.icon_view.IconView. If the icon_view already has a model set, it will remove it before setting the new model. If model is null, then it will unset the old model.

setPixbufColumn
void setPixbufColumn(int column)

Sets the column with pixbufs for icon_view to be column. The pixbuf column must be of type GDK_TYPE_PIXBUF

setReorderable
void setReorderable(bool reorderable)

This function is a convenience function to allow you to reorder models that support the gtk.tree_drag_source_iface.TreeDragSourceIface and the gtk.tree_drag_dest_iface.TreeDragDestIface. Both gtk.tree_store.TreeStore and gtk.list_store.ListStore support these. If reorderable is true, then the user can reorder the model by dragging and dropping rows. The developer can listen to these changes by connecting to the model's row_inserted and row_deleted signals. The reordering is implemented by setting up the icon view as a drag source and destination. Therefore, drag and drop can not be used in a reorderable view for any other purpose.

setRowSpacing
void setRowSpacing(int rowSpacing)

Sets the ::row-spacing property which specifies the space which is inserted between the rows of the icon view.

setSelectionMode
void setSelectionMode(gtk.types.SelectionMode mode)

Sets the selection mode of the icon_view.

setSpacing
void setSpacing(int spacing)

Sets the ::spacing property which specifies the space which is inserted between the cells (i.e. the icon and the text) of an item.

setTextColumn
void setTextColumn(int column)

Sets the column with text for icon_view to be column. The text column must be of type G_TYPE_STRING.

setTooltipCell
void setTooltipCell(gtk.tooltip.Tooltip tooltip, gtk.tree_path.TreePath path, gtk.cell_renderer.CellRenderer cell)

Sets the tip area of tooltip to the area which cell occupies in the item pointed to by path. See also gtk.tooltip.Tooltip.setTipArea.

setTooltipColumn
void setTooltipColumn(int column)

If you only plan to have simple (text-only) tooltips on full items, you can use this function to have gtk.icon_view.IconView handle these automatically for you. column should be set to the column in icon_view’s model containing the tooltip texts, or -1 to disable this feature.

setTooltipItem
void setTooltipItem(gtk.tooltip.Tooltip tooltip, gtk.tree_path.TreePath path)

Sets the tip area of tooltip to be the area covered by the item at path. See also gtk.icon_view.IconView.setTooltipColumn for a simpler alternative. See also gtk.tooltip.Tooltip.setTipArea.

unselectAll
void unselectAll()

Unselects all the icons.

unselectPath
void unselectPath(gtk.tree_path.TreePath path)

Unselects the row at path.

unsetModelDragDest
void unsetModelDragDest()

Undoes the effect of gtk.icon_view.IconView.enableModelDragDest. Calling this method sets gtk.icon_view.IconView:reorderable to false.

unsetModelDragSource
void unsetModelDragSource()

Undoes the effect of gtk.icon_view.IconView.enableModelDragSource. Calling this method sets gtk.icon_view.IconView:reorderable to false.

Static functions

newWithArea
gtk.icon_view.IconView newWithArea(gtk.cell_area.CellArea area)

Creates a new gtk.icon_view.IconView widget using the specified area to layout cells inside the icons.

newWithModel
gtk.icon_view.IconView newWithModel(gtk.tree_model.TreeModel model)

Creates a new gtk.icon_view.IconView widget with the model model.

Mixed In Members

From mixin CellLayoutT!()

addAttribute
void addAttribute(gtk.cell_renderer.CellRenderer cell, string attribute, int column)

Adds an attribute mapping to the list in cell_layout.

clear
void clear()

Unsets all the mappings on all renderers on cell_layout and removes all renderers from cell_layout.

clearAttributes
void clearAttributes(gtk.cell_renderer.CellRenderer cell)

Clears all existing attributes previously set with gtk.cell_layout.CellLayout.setAttributes.

getArea
gtk.cell_area.CellArea getArea()

Returns the underlying gtk.cell_area.CellArea which might be cell_layout if called on a gtk.cell_area.CellArea or might be null if no gtk.cell_area.CellArea is used by cell_layout.

getCells
gtk.cell_renderer.CellRenderer[] getCells()

Returns the cell renderers which have been added to cell_layout.

packEnd
void packEnd(gtk.cell_renderer.CellRenderer cell, bool expand)

Adds the cell to the end of cell_layout. If expand is false, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is true.

packStart
void packStart(gtk.cell_renderer.CellRenderer cell, bool expand)

Packs the cell into the beginning of cell_layout. If expand is false, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is true.

reorder
void reorder(gtk.cell_renderer.CellRenderer cell, int position)

Re-inserts cell at position.

setCellDataFunc
void setCellDataFunc(gtk.cell_renderer.CellRenderer cell, gtk.types.CellLayoutDataFunc func)

Sets the gtk.cell_layout.CellLayoutDataFunc to use for cell_layout.

From mixin ScrollableT!()

getBorder
bool getBorder(gtk.border.Border border)

Returns the size of a non-scrolling border around the outside of the scrollable.

getHadjustment
gtk.adjustment.Adjustment getHadjustment()

Retrieves the gtk.adjustment.Adjustment used for horizontal scrolling.

getHscrollPolicy
gtk.types.ScrollablePolicy getHscrollPolicy()

Gets the horizontal gtk.types.ScrollablePolicy.

getVadjustment
gtk.adjustment.Adjustment getVadjustment()

Retrieves the gtk.adjustment.Adjustment used for vertical scrolling.

getVscrollPolicy
gtk.types.ScrollablePolicy getVscrollPolicy()

Gets the vertical gtk.types.ScrollablePolicy.

setHadjustment
void setHadjustment(gtk.adjustment.Adjustment hadjustment)

Sets the horizontal adjustment of the gtk.scrollable.Scrollable.

setHscrollPolicy
void setHscrollPolicy(gtk.types.ScrollablePolicy policy)

Sets the gtk.types.ScrollablePolicy.

setVadjustment
void setVadjustment(gtk.adjustment.Adjustment vadjustment)

Sets the vertical adjustment of the gtk.scrollable.Scrollable.

setVscrollPolicy
void setVscrollPolicy(gtk.types.ScrollablePolicy policy)

Sets the gtk.types.ScrollablePolicy.

Inherited Members

From Widget

getDefaultDirection
gtk.types.TextDirection getDefaultDirection()

Obtains the current default reading direction.

setDefaultDirection
void setDefaultDirection(gtk.types.TextDirection 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.WidgetClass.installAction.

activate
bool activate()

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

activateAction
bool activateAction(string name, glib.variant.VariantG 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(gtk.event_controller.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(gtk.widget.Widget label)

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

addTickCallback
uint addTickCallback(gtk.types.TickCallback callback)

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

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

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

childFocus
bool childFocus(gtk.types.DirectionType direction)

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

computeBounds
bool computeBounds(gtk.widget.Widget target, graphene.rect.Rect outBounds)

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

computeExpand
bool computeExpand(gtk.types.Orientation orientation)

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

computePoint
bool computePoint(gtk.widget.Widget target, graphene.point.Point point, graphene.point.Point outPoint)

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

computeTransform
bool computeTransform(gtk.widget.Widget target, graphene.matrix.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
pango.context.Context createPangoContext()

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

createPangoLayout
pango.layout.Layout createPangoLayout(string text)

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

disposeTemplate
void disposeTemplate(gobject.types.GType widgetType)

Clears the template children for the given 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.

getAncestor
gtk.widget.Widget getAncestor(gobject.types.GType widgetType)

Gets the first ancestor of widget with type widget_type.

getBaseline
int getBaseline()

Returns the baseline that has currently been allocated to widget.

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.Widget.setChildVisible.

getClipboard
gdk.clipboard.Clipboard getClipboard()

Gets the clipboard object for widget.

getColor
void getColor(gdk.rgba.RGBA color)

Gets the current foreground color for the widget’s CSS style.

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
gdk.cursor.Cursor getCursor()

Queries the cursor set on widget.

getDirection
gtk.types.TextDirection getDirection()

Gets the reading direction for a particular widget.

getDisplay
gdk.display.Display getDisplay()

Get the gdk.display.Display for the toplevel window associated with this widget.

getFirstChild
gtk.widget.Widget getFirstChild()

Returns the widget’s first child.

getFocusChild
gtk.widget.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
pango.font_map.FontMap getFontMap()

Gets the font map of widget.

getFontOptions
cairo.font_options.FontOptions getFontOptions()

Returns the cairo.font_options.FontOptions of widget.

getFrameClock
gdk.frame_clock.FrameClock getFrameClock()

Obtains the frame clock for a widget.

getHalign
gtk.types.Align 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.Widget.setHexpand has been used to explicitly set the expand flag on this widget.

getLastChild
gtk.widget.Widget getLastChild()

Returns the widget’s last child.

getLayoutManager
gtk.layout_manager.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
gtk.native.Native getNative()

Returns the nearest gtk.native.Native ancestor of widget.

getNextSibling
gtk.widget.Widget getNextSibling()

Returns the widget’s next sibling.

getOpacity
double getOpacity()

#Fetches the requested opacity for this widget.

getOverflow
gtk.types.Overflow getOverflow()

Returns the widget’s overflow value.

getPangoContext
pango.context.Context getPangoContext()

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

getParent
gtk.widget.Widget getParent()

Returns the parent widget of widget.

getPreferredSize
void getPreferredSize(gtk.requisition.Requisition minimumSize, gtk.requisition.Requisition naturalSize)

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

getPrevSibling
gtk.widget.Widget getPrevSibling()

Returns the widget’s previous sibling.

getPrimaryClipboard
gdk.clipboard.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
gtk.types.SizeRequestMode getRequestMode()

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

getRoot
gtk.root.Root getRoot()

Returns the gtk.root.Root 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
gtk.settings.Settings getSettings()

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

getSize
int getSize(gtk.types.Orientation 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.Widget.setSizeRequest.

getStateFlags
gtk.types.StateFlags getStateFlags()

Returns the widget state as a flag set.

getStyleContext
gtk.style_context.StyleContext getStyleContext()

Returns the style context associated to widget.

getTemplateChild
gobject.object.ObjectG getTemplateChild(gobject.types.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
gtk.types.Align 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.Widget.setVexpand 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 gtk.window.Window 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.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, gio.action_group.ActionGroup group)

Inserts group into widget.

insertAfter
void insertAfter(gtk.widget.Widget parent, gtk.widget.Widget previousSibling)

Inserts widget into the child widget list of parent.

insertBefore
void insertBefore(gtk.widget.Widget parent, gtk.widget.Widget nextSibling)

Inserts widget into the child widget list of parent.

isAncestor
bool isAncestor(gtk.widget.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(gtk.types.DirectionType direction)

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

listMnemonicLabels
gtk.widget.Widget[] 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(gtk.types.Orientation 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 ::mnemonic-activate signal.

observeChildren
gio.list_model.ListModel observeChildren()

Returns a gio.list_model.ListModel to track the children of widget.

observeControllers
gio.list_model.ListModel observeControllers()

Returns a gio.list_model.ListModel to track the gtk.event_controller.EventControllers of widget.

pick
gtk.widget.Widget pick(double x, double y, gtk.types.PickFlags flags)

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

queueAllocate
void queueAllocate()

Flags the widget for a rerun of the vfuncGtk.Widget.size_allocate function.

queueDraw
void queueDraw()

Schedules this widget to be redrawn in the 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(gtk.event_controller.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(gtk.widget.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.Widget.addTickCallback.

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)

Clear all style classes applied to widget and replace them with classes.

setCursor
void setCursor(gdk.cursor.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(gtk.types.TextDirection dir)

Sets the reading direction on a particular widget.

setFocusChild
void setFocusChild(gtk.widget.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(pango.font_map.FontMap fontMap)

Sets the font map to use for Pango rendering.

setFontOptions
void setFontOptions(cairo.font_options.FontOptions options)

Sets the cairo.font_options.FontOptions used for Pango rendering in this widget.

setHalign
void setHalign(gtk.types.Align 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(gtk.layout_manager.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(gtk.types.Overflow overflow)

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

setParent
void setParent(gtk.widget.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(gtk.types.StateFlags 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(gtk.types.Align 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.

snapshotChild
void snapshotChild(gtk.widget.Widget child, gtk.snapshot.Snapshot snapshot)

Snapshot the a child of widget.

translateCoordinates
bool translateCoordinates(gtk.widget.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(gtk.types.StateFlags flags)

Turns off flag values for the current widget state.

connectDestroy
ulong connectDestroy(T callback, Flag!"After" after)

Connect to Destroy signal.

connectDirectionChanged
ulong connectDirectionChanged(T callback, Flag!"After" after)

Connect to DirectionChanged signal.

connectHide
ulong connectHide(T callback, Flag!"After" after)

Connect to Hide signal.

connectKeynavFailed
ulong connectKeynavFailed(T callback, Flag!"After" after)

Connect to KeynavFailed signal.

connectMap
ulong connectMap(T callback, Flag!"After" after)

Connect to Map signal.

connectMnemonicActivate
ulong connectMnemonicActivate(T callback, Flag!"After" after)

Connect to MnemonicActivate signal.

connectMoveFocus
ulong connectMoveFocus(T callback, Flag!"After" after)

Connect to MoveFocus signal.

connectQueryTooltip
ulong connectQueryTooltip(T callback, Flag!"After" after)

Connect to QueryTooltip signal.

connectRealize
ulong connectRealize(T callback, Flag!"After" after)

Connect to Realize signal.

connectShow
ulong connectShow(T callback, Flag!"After" after)

Connect to Show signal.

connectStateFlagsChanged
ulong connectStateFlagsChanged(T callback, Flag!"After" after)

Connect to StateFlagsChanged signal.

connectUnmap
ulong connectUnmap(T callback, Flag!"After" after)

Connect to Unmap signal.

connectUnrealize
ulong connectUnrealize(T callback, Flag!"After" after)

Connect to Unrealize signal.

From CellLayout

addAttribute
void addAttribute(gtk.cell_renderer.CellRenderer cell, string attribute, int column)

Adds an attribute mapping to the list in cell_layout.

clear
void clear()

Unsets all the mappings on all renderers on cell_layout and removes all renderers from cell_layout.

clearAttributes
void clearAttributes(gtk.cell_renderer.CellRenderer cell)

Clears all existing attributes previously set with gtk.cell_layout.CellLayout.setAttributes.

getArea
gtk.cell_area.CellArea getArea()

Returns the underlying gtk.cell_area.CellArea which might be cell_layout if called on a gtk.cell_area.CellArea or might be null if no gtk.cell_area.CellArea is used by cell_layout.

getCells
gtk.cell_renderer.CellRenderer[] getCells()

Returns the cell renderers which have been added to cell_layout.

packEnd
void packEnd(gtk.cell_renderer.CellRenderer cell, bool expand)

Adds the cell to the end of cell_layout. If expand is false, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is true.

packStart
void packStart(gtk.cell_renderer.CellRenderer cell, bool expand)

Packs the cell into the beginning of cell_layout. If expand is false, then the cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which expand is true.

reorder
void reorder(gtk.cell_renderer.CellRenderer cell, int position)

Re-inserts cell at position.

setCellDataFunc
void setCellDataFunc(gtk.cell_renderer.CellRenderer cell, gtk.types.CellLayoutDataFunc func)

Sets the gtk.cell_layout.CellLayoutDataFunc to use for cell_layout.

From Scrollable

getBorder
bool getBorder(gtk.border.Border border)

Returns the size of a non-scrolling border around the outside of the scrollable.

getHadjustment
gtk.adjustment.Adjustment getHadjustment()

Retrieves the gtk.adjustment.Adjustment used for horizontal scrolling.

getHscrollPolicy
gtk.types.ScrollablePolicy getHscrollPolicy()

Gets the horizontal gtk.types.ScrollablePolicy.

getVadjustment
gtk.adjustment.Adjustment getVadjustment()

Retrieves the gtk.adjustment.Adjustment used for vertical scrolling.

getVscrollPolicy
gtk.types.ScrollablePolicy getVscrollPolicy()

Gets the vertical gtk.types.ScrollablePolicy.

setHadjustment
void setHadjustment(gtk.adjustment.Adjustment hadjustment)

Sets the horizontal adjustment of the gtk.scrollable.Scrollable.

setHscrollPolicy
void setHscrollPolicy(gtk.types.ScrollablePolicy policy)

Sets the gtk.types.ScrollablePolicy.

setVadjustment
void setVadjustment(gtk.adjustment.Adjustment vadjustment)

Sets the vertical adjustment of the gtk.scrollable.Scrollable.

setVscrollPolicy
void setVscrollPolicy(gtk.types.ScrollablePolicy policy)

Sets the gtk.types.ScrollablePolicy.

Detailed Description

Deprecated: Use gtk.grid_view.GridView instead