gtk4/org.gtkkn.bindings.gtk/Image

Image

open class Image(pointer: <Error class: unknown class><<Error class: unknown class>>) : Widget

The GtkImage widget displays an image.

An example GtkImage

Various kinds of object can be displayed as an image; most typically, you would load a GdkTexture from a file, using the convenience function ctor@Gtk.Image.new_from_file, for instance:

GtkWidget *image = gtk_image_new_from_file ("myfile.png");

If the file isn’t loaded successfully, the image will contain a “broken image” icon similar to that used in many web browsers.

If you want to handle errors in loading the file yourself, for example by displaying an error message, then load the image with ctor@Gdk.Texture.new_from_file, then create the GtkImage with ctor@Gtk.Image.new_from_paintable.

Sometimes an application will want to avoid depending on external data files, such as image files. See the documentation of GResource inside GIO, for details. In this case, property@Gtk.Image:resource, ctor@Gtk.Image.new_from_resource, and method@Gtk.Image.set_from_resource should be used.

GtkImage displays its image as an icon, with a size that is determined by the application. See class@Gtk.Picture if you want to show an image at is actual size.

CSS nodes

GtkImage has a single CSS node with the name image. The style classes .normal-icons or .large-icons may appear, depending on the property@Gtk.Image:icon-size property.

Accessibility

GtkImage uses the GTK_ACCESSIBLE_ROLE_IMG role.

Skipped during bindings generation

method file: Property has no getter nor setter
method gicon: Property TypeInfo of getter and setter do not match
method resource: Property has no getter nor setter
method use-fallback: Property has no getter nor setter

Constructors

Image

constructor()

Creates a new empty GtkImage widget.

constructor(filename: String)

Creates a new GtkImage displaying the file @filename.

constructor(icon: <Error class: unknown class>)

Creates a GtkImage displaying an icon from the current icon theme.

constructor(iconName: String? = null)

Creates a GtkImage displaying an icon from the current icon theme.

constructor(paintable: <Error class: unknown class>? = null)

Creates a new GtkImage displaying @paintable.

constructor(pixbuf: <Error class: unknown class>? = null)

Creates a new GtkImage displaying @pixbuf.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

accessibleRole

open val accessibleRole: AccessibleRole

The accessible role of the given GtkAccessible implementation.

canFocus

open var canFocus: Boolean

Whether the widget or any of its descendents can accept the input focus.

canTarget

open var canTarget: Boolean

Whether the widget can receive pointer events.

cssClasses

open var cssClasses: List<String>

A list of css classes applied to this widget.

cssName

open val cssName: String

The name of this widget in the CSS tree.

cursor

open var cursor: <Error class: unknown class>?

The cursor used by @widget.

focusable

open var focusable: Boolean

Whether this widget itself will accept the input focus.

focusOnClick

open var focusOnClick: Boolean

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

gtkAccessiblePointer

open override val gtkAccessiblePointer: <Error class: unknown class><<Error class: unknown class>>

gtkBuildablePointer

open override val gtkBuildablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkConstraintTargetPointer

open override val gtkConstraintTargetPointer: <Error class: unknown class><<Error class: unknown class>>

gtkImagePointer

val gtkImagePointer: <Error class: unknown class><<Error class: unknown class>>

gtkWidgetPointer

val gtkWidgetPointer: <Error class: unknown class><<Error class: unknown class>>

halign

open var halign: Align

How to distribute horizontal space if widget gets extra space.

hasTooltip

open var hasTooltip: Boolean

Enables or disables the emission of the ::query-tooltip signal on @widget.

hexpand

open var hexpand: Boolean

Whether to expand horizontally.

hexpandSet

open var hexpandSet: Boolean

Whether to use the hexpand property.

iconName

open var iconName: String?

The name of the icon in the icon theme.

iconSize

open var iconSize: IconSize

The symbolic size to display icons at.

layoutManager

open var layoutManager: LayoutManager?

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

marginBottom

open var marginBottom: <Error class: unknown class>

Margin on bottom side of widget.

marginEnd

open var marginEnd: <Error class: unknown class>

Margin on end of widget, horizontally.

marginStart

open var marginStart: <Error class: unknown class>

Margin on start of widget, horizontally.

marginTop

open var marginTop: <Error class: unknown class>

Margin on top side of widget.

name

open var name: String

The name of the widget.

opacity

open var opacity: <Error class: unknown class>

The requested opacity of the widget.

overflow

open var overflow: Overflow

How content outside the widget's content area is treated.

paintable

open var paintable: <Error class: unknown class>?

The GdkPaintable to display.

parent

open val parent: Widget?

The parent widget of this widget.

pixelSize

open var pixelSize: <Error class: unknown class>

The size in pixels to display icons at.

receivesDefault

open var receivesDefault: Boolean

Whether the widget will receive the default action when it is focused.

root

open val root: Root?

The GtkRoot widget of the widget tree containing this widget.

scaleFactor

open val scaleFactor: <Error class: unknown class>

The scale factor of the widget.

storageType

open val storageType: ImageType

The representation being used for image data.

tooltipMarkup

open var tooltipMarkup: String?

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

tooltipText

open var tooltipText: String?

Sets the text of tooltip to be the given string.

valign

open var valign: Align

How to distribute vertical space if widget gets extra space.

vexpand

open var vexpand: Boolean

Whether to expand vertically.

vexpandSet

open var vexpandSet: Boolean

Whether to use the vexpand property.

Functions

actionSetEnabled

open fun actionSetEnabled(actionName: String, enabled: Boolean)

Enable or disable an action installed with gtk_widget_class_install_action().

activateActionIfExists

open fun activateActionIfExists(name: String, args: <Error class: unknown class>? = null): Boolean

Looks up the action in the action groups associated with

activateDefault

open fun activateDefault()

Activates the default.activate action from @widget.

activateWidget

open fun activateWidget(): Boolean

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

addController

open fun addController(controller: EventController)

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

addCssClass

open fun addCssClass(cssClass: String)

Adds a style class to @widget.

addMnemonicLabel

open fun addMnemonicLabel(label: Widget)

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

addTickCallback

open fun addTickCallback(callback: TickCallback): <Error class: unknown class>

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

allocate

open fun allocate(width: <Error class: unknown class>, height: <Error class: unknown class>, baseline: <Error class: unknown class>, transform: <Error class: unknown class>? = null)

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

announce

open fun announce(message: String, priority: AccessibleAnnouncementPriority)

Requests the user's screen reader to announce the given message.

childFocus

open fun childFocus(direction: DirectionType): Boolean

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

clear

open fun clear()

Resets the image to be empty.

computeBounds

open fun computeBounds(target: Widget, outBounds: <Error class: unknown class>): Boolean

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

computeExpand

open fun computeExpand(orientation: Orientation): Boolean

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

computePoint

open fun computePoint(target: Widget, point: <Error class: unknown class>, outPoint: <Error class: unknown class>): Boolean

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

computeTransform

open fun computeTransform(target: Widget, outTransform: <Error class: unknown class>): Boolean

Computes a matrix suitable to describe a transformation from

connectDestroy

fun connectDestroy(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

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

connectDirectionChanged

fun connectDirectionChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (previousDirection: TextDirection) -> Unit): <Error class: unknown class>

Emitted when the text direction of a widget changes.

connectHide

fun connectHide(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when @widget is hidden.

connectKeynavFailed

fun connectKeynavFailed(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (direction: DirectionType) -> Boolean): <Error class: unknown class>

Emitted if keyboard navigation fails.

connectMap

fun connectMap(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when @widget is going to be mapped.

connectMnemonicActivate

fun connectMnemonicActivate(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (groupCycling: Boolean) -> Boolean): <Error class: unknown class>

Emitted when a widget is activated via a mnemonic.

connectMoveFocus

fun connectMoveFocus(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (direction: DirectionType) -> Unit): <Error class: unknown class>

Emitted when the focus is moved.

connectQueryTooltip

fun connectQueryTooltip(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (<Error class: unknown class>, <Error class: unknown class>, keyboardMode: Boolean, tooltip: Tooltip) -> Boolean): <Error class: unknown class>

Emitted when the widget’s tooltip is about to be shown.

connectRealize

fun connectRealize(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when @widget is associated with a GdkSurface.

connectShow

fun connectShow(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when @widget is shown.

connectStateFlagsChanged

fun connectStateFlagsChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (flags: StateFlags) -> Unit): <Error class: unknown class>

Emitted when the widget state changes.

connectUnmap

fun connectUnmap(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when @widget is going to be unmapped.

connectUnrealize

fun connectUnrealize(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when the GdkSurface associated with @widget is destroyed.

contains

open fun contains(x: <Error class: unknown class>, y: <Error class: unknown class>): Boolean

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

createPangoContext

open fun createPangoContext(): <Error class: unknown class>

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

createPangoLayout

open fun createPangoLayout(text: String? = null): <Error class: unknown class>

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

disposeTemplate

open fun disposeTemplate(widgetType: <Error class: unknown class>)

Clears the template children for the given widget.

dragCheckThreshold

open fun dragCheckThreshold(startX: <Error class: unknown class>, startY: <Error class: unknown class>, currentX: <Error class: unknown class>, currentY: <Error class: unknown class>): Boolean

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

errorBell

open fun errorBell()

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

getAccessibleParent

open fun getAccessibleParent(): Accessible?

Retrieves the accessible parent for an accessible object.

getAccessibleRole

open fun getAccessibleRole(): AccessibleRole

Retrieves the accessible role of an accessible object.

getAllocatedBaseline

open fun getAllocatedBaseline(): <Error class: unknown class>

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

getAllocatedHeight

open fun getAllocatedHeight(): <Error class: unknown class>

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

getAllocatedWidth

open fun getAllocatedWidth(): <Error class: unknown class>

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

getAncestor

open fun getAncestor(widgetType: <Error class: unknown class>): Widget?

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

getAtContext

open fun getAtContext(): AtContext

Retrieves the accessible implementation for the given GtkAccessible.

getBaseline

open fun getBaseline(): <Error class: unknown class>

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

getBuildableId

open fun getBuildableId(): String?

Gets the ID of the @buildable object.

getChildVisible

open fun getChildVisible(): Boolean

Gets the value set with gtk_widget_set_child_visible().

getClipboard

open fun getClipboard(): <Error class: unknown class>

Gets the clipboard object for @widget.

getColor

open fun getColor(color: <Error class: unknown class>)

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

getDirection

open fun getDirection(): TextDirection

Gets the reading direction for a particular widget.

getDisplay

open fun getDisplay(): <Error class: unknown class>

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

getFirstAccessibleChild

open fun getFirstAccessibleChild(): Accessible?

Retrieves the first accessible child of an accessible object.

getFirstChild

open fun getFirstChild(): Widget?

Returns the widget’s first child.

getFocusChild

open fun getFocusChild(): Widget?

Returns the current focus child of @widget.

getFontMap

open fun getFontMap(): <Error class: unknown class>?

Gets the font map of @widget.

getFrameClock

open fun getFrameClock(): <Error class: unknown class>?

Obtains the frame clock for a widget.

getGicon

open fun getGicon(): <Error class: unknown class>?

Gets the GIcon being displayed by the GtkImage.

getHeight

open fun getHeight(): <Error class: unknown class>

Returns the content height of the widget.

getLastChild

open fun getLastChild(): Widget?

Returns the widget’s last child.

getMapped

open fun getMapped(): Boolean

Whether the widget is mapped.

getNative

open fun getNative(): Native?

Returns the nearest GtkNative ancestor of @widget.

getNextAccessibleSibling

open fun getNextAccessibleSibling(): Accessible?

Retrieves the next accessible sibling of an accessible object

getNextSibling

open fun getNextSibling(): Widget?

Returns the widget’s next sibling.

getPangoContext

open fun getPangoContext(): <Error class: unknown class>

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

getPlatformState

open fun getPlatformState(state: AccessiblePlatformState): Boolean

Query a platform state, such as focus.

getPreferredSize

open fun getPreferredSize(minimumSize: Requisition?, naturalSize: Requisition?)

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

getPrevSibling

open fun getPrevSibling(): Widget?

Returns the widget’s previous sibling.

getPrimaryClipboard

open fun getPrimaryClipboard(): <Error class: unknown class>

Gets the primary clipboard of @widget.

getRealized

open fun getRealized(): Boolean

Determines whether @widget is realized.

getRequestMode

open fun getRequestMode(): SizeRequestMode

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

getSensitive

open fun getSensitive(): Boolean

Returns the widget’s sensitivity.

getSettings

open fun getSettings(): Settings

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

getSize

open fun getSize(orientation: Orientation): <Error class: unknown class>

Returns the content width or height of the widget.

getStateFlags

open fun getStateFlags(): StateFlags

Returns the widget state as a flag set.

getStyleContext

open fun getStyleContext(): StyleContext

Returns the style context associated to @widget.

getTemplateChild

open fun getTemplateChild(widgetType: <Error class: unknown class>, name: String): <Error class: unknown class>

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

getVisible

open fun getVisible(): Boolean

Determines whether the widget is visible.

getWidth

open fun getWidth(): <Error class: unknown class>

Returns the content width of the widget.

grabFocus

open fun grabFocus(): Boolean

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

hasCssClass

open fun hasCssClass(cssClass: String): Boolean

Returns whether @css_class is currently applied to @widget.

hasDefault

open fun hasDefault(): Boolean

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

hasFocus

open fun hasFocus(): Boolean

Determines if the widget has the global input focus.

hasVisibleFocus

open fun hasVisibleFocus(): Boolean

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

hide

open fun hide()

Reverses the effects of gtk_widget_show().

inDestruction

open fun inDestruction(): Boolean

Returns whether the widget is currently being destroyed.

initTemplate

open fun initTemplate()

Creates and initializes child widgets defined in templates.

insertActionGroup

open fun insertActionGroup(name: String, group: <Error class: unknown class>? = null)

Inserts @group into @widget.

insertAfter

open fun insertAfter(parent: Widget, previousSibling: Widget? = null)

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

insertBefore

open fun insertBefore(parent: Widget, nextSibling: Widget? = null)

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

isAncestor

open fun isAncestor(ancestor: Widget): Boolean

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

isDrawable

open fun isDrawable(): Boolean

Determines whether @widget can be drawn to.

isFocus

open fun isFocus(): Boolean

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

isSensitive

open fun isSensitive(): Boolean

Returns the widget’s effective sensitivity.

isVisible

open fun isVisible(): Boolean

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

keynavFailed

open fun keynavFailed(direction: DirectionType): Boolean

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

listMnemonicLabels

open fun listMnemonicLabels(): <Error class: unknown class>

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

map

open fun map()

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

mnemonicActivate

open fun mnemonicActivate(groupCycling: Boolean): Boolean

Emits the ::mnemonic-activate signal.

observeChildren

open fun observeChildren(): <Error class: unknown class>

Returns a GListModel to track the children of @widget.

observeControllers

open fun observeControllers(): <Error class: unknown class>

Returns a GListModel to track the class@Gtk.EventControllers of @widget.

pick

open fun pick(x: <Error class: unknown class>, y: <Error class: unknown class>, flags: PickFlags): Widget?

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

queueAllocate

open fun queueAllocate()

Flags the widget for a rerun of the vfunc@Gtk.Widget.size_allocate function.

queueDraw

open fun queueDraw()

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

queueResize

open fun queueResize()

Flags a widget to have its size renegotiated.

realize

open fun realize()

Creates the GDK resources associated with a widget.

removeController

open fun removeController(controller: EventController)

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

removeCssClass

open fun removeCssClass(cssClass: String)

Removes a style from @widget.

removeMnemonicLabel

open fun removeMnemonicLabel(label: Widget)

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

removeTickCallback

open fun removeTickCallback(id: <Error class: unknown class>)

Removes a tick callback previously registered with gtk_widget_add_tick_callback().

resetProperty

open fun resetProperty(property: AccessibleProperty)

Resets the accessible @property to its default value.

resetRelation

open fun resetRelation(relation: AccessibleRelation)

Resets the accessible @relation to its default value.

resetState

open fun resetState(state: AccessibleState)

Resets the accessible @state to its default value.

setAccessibleParent

open fun setAccessibleParent(parent: Accessible? = null, nextSibling: Accessible? = null)

Sets the parent and sibling of an accessible object.

setChildVisible

open fun setChildVisible(childVisible: Boolean)

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

setCursorFromName

open fun setCursorFromName(name: String? = null)

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

setDirection

open fun setDirection(dir: TextDirection)

Sets the reading direction on a particular widget.

setFocusChild

open fun setFocusChild(child: Widget? = null)

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

setFontMap

open fun setFontMap(fontMap: <Error class: unknown class>? = null)

Sets the font map to use for Pango rendering.

setFromFile

open fun setFromFile(filename: String? = null)

Sets a GtkImage to show a file.

setFromGicon

open fun setFromGicon(icon: <Error class: unknown class>)

Sets a GtkImage to show a GIcon.

setFromPixbuf

open fun setFromPixbuf(pixbuf: <Error class: unknown class>? = null)

Sets a GtkImage to show a GdkPixbuf.

setFromResource

open fun setFromResource(resourcePath: String? = null)

Sets a GtkImage to show a resource.

setMargins

fun Widget.setMargins(all: Int)

Set all margins to the same value.

fun Widget.setMargins(horizontal: Int = 0, vertical: Int = 0)

Set start and end margin to horizontal and top and bottom margin to vertical

fun Widget.setMargins(start: Int = 0, top: Int = 0, end: Int = 0, bottom: Int = 0)

Set margins.

setParent

open fun setParent(parent: Widget)

Sets @parent as the parent widget of @widget.

setSensitive

open fun setSensitive(sensitive: Boolean)

Sets the sensitivity of a widget.

setSizeRequest

open fun setSizeRequest(width: <Error class: unknown class>, height: <Error class: unknown class>)

Sets the minimum size of a widget.

setStateFlags

open fun setStateFlags(flags: StateFlags, clear: Boolean)

Turns on flag values in the current widget state.

setVisible

open fun setVisible(visible: Boolean)

Sets the visibility state of @widget.

shouldLayout

open fun shouldLayout(): Boolean

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

show

open fun show()

Flags a widget to be displayed.

triggerTooltipQuery

open fun triggerTooltipQuery()

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

unmap

open fun unmap()

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

unparent

open fun unparent()

Dissociate @widget from its parent.

unrealize

open fun unrealize()

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

unsetStateFlags

open fun unsetStateFlags(flags: StateFlags)

Turns off flag values for the current widget state.

updateNextAccessibleSibling

open fun updateNextAccessibleSibling(newSibling: Accessible? = null)

Updates the next accessible sibling of @self.