Class
GtkPicture
Description [src]
final class Gtk.Picture : Gtk.Widget {
/* No available fields */
}
The GtkPicture
widget displays a GdkPaintable
.
Many convenience functions are provided to make pictures simple to use. For example, if you want to load an image from a file, and then display it, there’s a convenience function to do this:
GtkWidget *widget = gtk_picture_new_for_filename ("myfile.png");
If the file isn’t loaded successfully, the picture 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
gdk_texture_new_from_file()
, then create the GtkPicture
with
gtk_picture_new_for_paintable()
.
Sometimes an application will want to avoid depending on external data
files, such as image files. See the documentation of GResource
for details.
In this case, gtk_picture_new_for_resource()
and
gtk_picture_set_resource()
should be used.
GtkPicture
displays an image at its natural size. See GtkImage
if you want to display a fixed-size image, such as an icon.
Sizing the paintable
You can influence how the paintable is displayed inside the GtkPicture
by changing GtkPicture:content-fit
. See GtkContentFit
for details. GtkPicture:can-shrink
can be unset to make sure
that paintables are never made smaller than their ideal size - but
be careful if you do not know the size of the paintable in use (like
when displaying user-loaded images). This can easily cause the picture to
grow larger than the screen. And GtkWidget:halign
and
GtkWidget:valign
can be used to make sure the paintable doesn’t
fill all available space but is instead displayed at its original size.
CSS nodes
GtkPicture
has a single CSS node with the name picture
.
Accessibility
GtkPicture
uses the GTK_ACCESSIBLE_ROLE_IMG
role.
Ancestors
- GtkWidget
- GInitiallyUnowned
- GObject
Constructors
gtk_picture_new
Creates a new empty GtkPicture
widget.
gtk_picture_new_for_file
Creates a new GtkPicture
displaying the given file
.
gtk_picture_new_for_filename
Creates a new GtkPicture
displaying the file filename
.
gtk_picture_new_for_paintable
Creates a new GtkPicture
displaying paintable
.
gtk_picture_new_for_resource
Creates a new GtkPicture
displaying the resource at resource_path
.
Instance methods
gtk_picture_get_alternative_text
Gets the alternative textual description of the picture.
gtk_picture_get_can_shrink
Returns whether the GtkPicture
respects its contents size.
gtk_picture_get_content_fit
Returns the fit mode for the content of the GtkPicture
.
Available since: 4.8
gtk_picture_get_file
Gets the GFile
currently displayed if self
is displaying a file.
gtk_picture_get_keep_aspect_ratio
Returns whether the GtkPicture
preserves its contents aspect ratio.
Deprecated since: 4.8
gtk_picture_get_paintable
Gets the GdkPaintable
being displayed by the GtkPicture
.
gtk_picture_set_alternative_text
Sets an alternative textual description for the picture contents.
gtk_picture_set_can_shrink
If set to TRUE
, the self
can be made smaller than its contents.
gtk_picture_set_content_fit
Sets how the content should be resized to fit the GtkPicture
.
Available since: 4.8
gtk_picture_set_file
Makes self
load and display file
.
gtk_picture_set_filename
Makes self
load and display the given filename
.
gtk_picture_set_keep_aspect_ratio
If set to TRUE
, the self
will render its contents according to
their aspect ratio.
Deprecated since: 4.8
gtk_picture_set_paintable
Makes self
display the given paintable
.
gtk_picture_set_resource
Makes self
load and display the resource at the given
resource_path
.
Methods inherited from GtkWidget (162)
gtk_widget_action_set_enabled
Enable or disable an action installed with
gtk_widget_class_install_action()
.
gtk_widget_activate
For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.
gtk_widget_activate_action
Looks up the action in the action groups associated
with widget
and its ancestors, and activates it.
gtk_widget_activate_action_variant
Looks up the action in the action groups associated with
widget
and its ancestors, and activates it.
gtk_widget_activate_default
Activates the default.activate
action from widget
.
gtk_widget_add_controller
Adds controller
to widget
so that it will receive events.
gtk_widget_add_css_class
Adds a style class to widget
.
gtk_widget_add_mnemonic_label
Adds a widget to the list of mnemonic labels for this widget.
gtk_widget_add_tick_callback
Queues an animation frame update and adds a callback to be called before each frame.
gtk_widget_allocate
This function is only used by GtkWidget
subclasses, to
assign a size, position and (optionally) baseline to their
child widgets.
gtk_widget_child_focus
Called by widgets as the user moves around the window using keyboard shortcuts.
gtk_widget_compute_bounds
Computes the bounds for widget
in the coordinate space of target
.
gtk_widget_compute_expand
Computes whether a container should give this widget extra space when possible.
gtk_widget_compute_point
Translates the given point
in widget
‘s coordinates to coordinates
relative to target
’s coordinate system.
gtk_widget_compute_transform
Computes a matrix suitable to describe a transformation from
widget
‘s coordinate system into target
‘s coordinate system.
gtk_widget_contains
Tests if the point at (x
, y
) is contained in widget
.
gtk_widget_create_pango_context
Creates a new PangoContext
with the appropriate font map,
font options, font description, and base direction for drawing
text for this widget.
gtk_widget_create_pango_layout
Creates a new PangoLayout
with the appropriate font map,
font description, and base direction for drawing text for
this widget.
gtk_widget_dispose_template
Clears the template children for the given widget.
Available since: 4.8
gtk_drag_check_threshold
Checks to see if a drag movement has passed the GTK drag threshold.
gtk_widget_error_bell
Notifies the user about an input-related error on this widget.
gtk_widget_get_allocated_baseline
Returns the baseline that has currently been allocated to widget
.
Deprecated since: 4.12
gtk_widget_get_allocated_height
Returns the height that has currently been allocated to widget
.
Deprecated since: 4.12
Methods inherited from GtkAccessible (18)
gtk_accessible_get_accessible_parent
Retrieves the accessible parent for an accessible object.
Available since: 4.10
gtk_accessible_get_accessible_role
Retrieves the accessible role of an accessible object.
gtk_accessible_get_at_context
Retrieves the accessible implementation for the given GtkAccessible
.
Available since: 4.10
gtk_accessible_get_bounds
Queries the coordinates and dimensions of this accessible.
Available since: 4.10
gtk_accessible_get_first_accessible_child
Retrieves the first accessible child of an accessible object.
Available since: 4.10
gtk_accessible_get_next_accessible_sibling
Retrieves the next accessible sibling of an accessible object.
Available since: 4.10
gtk_accessible_get_platform_state
Query a platform state, such as focus.
Available since: 4.10
gtk_accessible_reset_property
Resets the accessible property
to its default value.
gtk_accessible_reset_relation
Resets the accessible relation
to its default value.
gtk_accessible_reset_state
Resets the accessible state
to its default value.
gtk_accessible_set_accessible_parent
Sets the parent and sibling of an accessible object.
Available since: 4.10
gtk_accessible_update_next_accessible_sibling
Updates the next accessible sibling of self
.
Available since: 4.10
gtk_accessible_update_property
Updates a list of accessible properties.
gtk_accessible_update_property_value
Updates an array of accessible properties.
gtk_accessible_update_relation
Updates a list of accessible relations.
gtk_accessible_update_relation_value
Updates an array of accessible relations.
gtk_accessible_update_state
Updates a list of accessible states. See the GtkAccessibleState
documentation for the value types of accessible states.
gtk_accessible_update_state_value
Updates an array of accessible states.
Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id
Gets the ID of the buildable
object.
Properties
Gtk.Picture:alternative-text
The alternative textual description for the picture.
Gtk.Picture:can-shrink
If the GtkPicture
can be made smaller than the natural size of its contents.
Gtk.Picture:content-fit
How the content should be resized to fit inside the GtkPicture
.
Available since: 4.8
Gtk.Picture:file
The GFile
that is displayed or NULL
if none.
Gtk.Picture:keep-aspect-ratio
Whether the GtkPicture will render its contents trying to preserve the aspect ratio.
Deprecated since: 4.8
Gtk.Picture:paintable
The GdkPaintable
to be displayed by this GtkPicture
.
Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus
Whether the widget or any of its descendents can accept the input focus.
Gtk.Widget:can-target
Whether the widget can receive pointer events.
Gtk.Widget:css-classes
A list of css classes applied to this widget.
Gtk.Widget:css-name
The name of this widget in the CSS tree.
Gtk.Widget:cursor
The cursor used by widget
.
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
Gtk.Widget:focusable
Whether this widget itself will accept the input focus.
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space.
Gtk.Widget:has-default
Whether the widget is the default widget.
Gtk.Widget:has-focus
Whether the widget has the input focus.
Gtk.Widget:has-tooltip
Enables or disables the emission of the ::query-tooltip signal on widget
.
Gtk.Widget:height-request
Override for height request of the widget.
Gtk.Widget:hexpand
Whether to expand horizontally.
Gtk.Widget:hexpand-set
Whether to use the hexpand
property.
Gtk.Widget:layout-manager
The GtkLayoutManager
instance to use to compute the preferred size
of the widget, and allocate its children.
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
Gtk.Widget:margin-end
Margin on end of widget, horizontally.
Gtk.Widget:margin-start
Margin on start of widget, horizontally.
Gtk.Widget:margin-top
Margin on top side of widget.
Gtk.Widget:name
The name of the widget.
Gtk.Widget:opacity
The requested opacity of the widget.
Gtk.Widget:overflow
How content outside the widget’s content area is treated.
Gtk.Widget:parent
The parent widget of this widget.
Gtk.Widget:receives-default
Whether the widget will receive the default action when it is focused.
Gtk.Widget:root
The GtkRoot
widget of the widget tree containing this widget.
Gtk.Widget:scale-factor
The scale factor of the widget.
Gtk.Widget:sensitive
Whether the widget responds to input.
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space.
Gtk.Widget:vexpand
Whether to expand vertically.
Gtk.Widget:vexpand-set
Whether to use the vexpand
property.
Gtk.Widget:visible
Whether the widget is visible.
Gtk.Widget:width-request
Override for width request of the widget.
Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role
The accessible role of the given GtkAccessible
implementation.