|
gtkmm
3.97.1
|
A widget displaying an image. More...
#include <gtkmm/image.h>

Public Types | |
| enum | Type { Type::EMPTY, Type::ICON_NAME, Type::GICON, Type::PAINTABLE } |
| Describes the image data representation used by a Gtk::Image. More... | |
Public Types inherited from Gtk::Widget | |
| using | SlotTick = sigc::slot< bool(const Glib::RefPtr< Gdk::FrameClock >&)> |
| Callback type for adding a function to update animations. More... | |
Public Types inherited from Glib::Object | |
| typedef void(*)(gpointer data | DestroyNotify) |
Public Types inherited from sigc::trackable | |
| typedef internal::func_destroy_notify | func_destroy_notify |
Public Types inherited from sigc::notifiable | |
| typedef internal::func_destroy_notify | func_destroy_notify |
Public Member Functions | |
| Image (Image&& src) noexcept | |
| Image& | operator= (Image&& src) noexcept |
| Image (const Image&)=delete | |
| Image& | operator= (const Image&)=delete |
| ~Image () noexcept override | |
| GtkImage* | gobj () |
| Provides access to the underlying C GObject. More... | |
| const GtkImage* | gobj () const |
| Provides access to the underlying C GObject. More... | |
| Image () | |
| Image (const std::string& file) | |
| Creates an Image widget displaying the file filename. More... | |
| Image (const Glib::RefPtr< Gdk::Pixbuf >& pixbuf) | |
| Creates a new Image widget displaying pixbuf. More... | |
| Image (const Glib::RefPtr< Gdk::Paintable >& paintable) | |
| Creates a new Gtk::Image displaying paintable. More... | |
| Image (const Glib::RefPtr< Gio::Icon >& gicon) | |
| Creates a Gtk::Image displaying an icon from the current icon theme. More... | |
| void | set (const std::string& filename) |
| See the Image::Image(const std::string& file) constructor for details. More... | |
| void | set_from_resource (const std::string& resource_path) |
| See new_from_resource() for details. More... | |
| void | set (const Glib::RefPtr< Gdk::Pixbuf >& pixbuf) |
| See the Image::Image(const Glib::RefPtr<Gdk::Pixbuf>& pixbuf) constructor for details. More... | |
| void | set (const Glib::RefPtr< Gdk::Paintable >& paintable) |
| See new_from_paintable() for details. More... | |
| void | set (const Glib::RefPtr< const Gio::Icon >& icon) |
| See new_from_gicon() for details. More... | |
| void | set_from_icon_name (const Glib::ustring& icon_name) |
| Causes the Image to display an icon from the current icon theme. More... | |
| void | clear () |
| Resets the image to be empty. More... | |
| Type | get_storage_type () const |
| Gets the type of representation being used by the Gtk::Image to store image data. More... | |
| Glib::RefPtr< Gdk::Paintable > | get_paintable () |
| Gets the image Gdk::Paintable being displayed by the Gtk::Image. More... | |
| Glib::RefPtr< const Gdk::Paintable > | get_paintable () const |
| Gets the image Gdk::Paintable being displayed by the Gtk::Image. More... | |
| void | set_icon_size (IconSize icon_size) |
| Suggests an icon size to the theme for named icons. More... | |
| IconSize | get_icon_size () const |
| Gets the icon size used by the image when rendering icons. More... | |
| Glib::RefPtr< Gio::Icon > | get_gicon () |
| Gets the Gio::Icon and size being displayed by the Gtk::Image. More... | |
| Glib::RefPtr< const Gio::Icon > | get_gicon () const |
| Gets the Gio::Icon and size being displayed by the Gtk::Image. More... | |
| Glib::ustring | get_icon_name () const |
| Gets the icon name and size being displayed by the Gtk::Image. More... | |
| int | get_pixel_size () const |
| Gets the pixel size used for named icons. More... | |
| void | set_pixel_size (int pixel_size) |
| Sets the pixel size to use for named icons. More... | |
| Glib::PropertyProxy< Glib::ustring > | property_file () |
| Filename to load and display. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_file () const |
| Filename to load and display. More... | |
| Glib::PropertyProxy< IconSize > | property_icon_size () |
| Symbolic size to use for icon set or named icon. More... | |
| Glib::PropertyProxy_ReadOnly< IconSize > | property_icon_size () const |
| Symbolic size to use for icon set or named icon. More... | |
| Glib::PropertyProxy< int > | property_pixel_size () |
| The "pixel-size" property can be used to specify a fixed size overriding the Gtk::Image::property_icon_size() property for images of type Gtk::Image::Type::ICON_NAME. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_pixel_size () const |
| The "pixel-size" property can be used to specify a fixed size overriding the Gtk::Image::property_icon_size() property for images of type Gtk::Image::Type::ICON_NAME. More... | |
| Glib::PropertyProxy< Glib::ustring > | property_icon_name () |
| The name of the icon in the icon theme. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_icon_name () const |
| The name of the icon in the icon theme. More... | |
| Glib::PropertyProxy_ReadOnly< Type > | property_storage_type () const |
| The representation being used for image data. More... | |
| Glib::PropertyProxy< Glib::RefPtr< Gio::Icon > > | property_gicon () |
| The GIcon displayed in the GtkImage. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::Icon > > | property_gicon () const |
| The GIcon displayed in the GtkImage. More... | |
| Glib::PropertyProxy< bool > | property_use_fallback () |
| Whether the icon displayed in the GtkImage will use standard icon names fallback. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_use_fallback () const |
| Whether the icon displayed in the GtkImage will use standard icon names fallback. More... | |
| Glib::PropertyProxy< std::string > | property_resource () |
| A path to a resource file to display. More... | |
| Glib::PropertyProxy_ReadOnly< std::string > | property_resource () const |
| A path to a resource file to display. More... | |
| Glib::PropertyProxy< Glib::RefPtr< Gdk::Paintable > > | property_paintable () |
| A GdkPaintable to display. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Paintable > > | property_paintable () const |
| A GdkPaintable to display. More... | |
Public Member Functions inherited from Gtk::Widget | |
| Widget (Widget&& src) noexcept | |
| Widget& | operator= (Widget&& src) noexcept |
| Widget (const Widget&)=delete | |
| Widget& | operator= (const Widget&)=delete |
| ~Widget () noexcept override | |
| Destroys the widget. More... | |
| GtkWidget* | gobj () |
| Provides access to the underlying C GObject. More... | |
| const GtkWidget* | gobj () const |
| Provides access to the underlying C GObject. More... | |
| Glib::RefPtr< ConstraintTarget > | make_refptr_constrainttarget () |
| Converts this widget to a reference counted Gtk::ConstraintTarget. More... | |
| Glib::RefPtr< const ConstraintTarget > | make_refptr_constrainttarget () const |
| Converts this widget to a reference counted Gtk::ConstraintTarget. More... | |
| void | show () |
| Flags a widget to be displayed. More... | |
| void | hide () |
| Reverses the effects of show(), causing the widget to be hidden (invisible to the user). More... | |
| void | queue_draw () |
| Schedules this widget to be redrawn in paint phase of the current or the next frame. More... | |
| void | queue_resize () |
| This function is only for use in widget implementations. More... | |
| void | queue_allocate () |
| This function is only for use in widget implementations. More... | |
| void | size_allocate (const Allocation& allocation, int baseline) |
| This is a simple form of allocate() that takes the new position of widget as part of allocation. More... | |
| SizeRequestMode | get_request_mode () const |
| Gets whether the widget prefers a height-for-width layout or a width-for-height layout. More... | |
| void | measure (Orientation orientation, int for_size, int& minimum, int& natural, int& minimum_baseline, int& natural_baseline) const |
| Measures widget in the orientation orientation and for the given for_size. More... | |
| void | get_preferred_size (Requisition& minimum_size, Requisition& natural_size) const |
| Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management. More... | |
| void | set_layout_manager (const Glib::RefPtr< LayoutManager >& layout_manager) |
| Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of widget. More... | |
| void | unset_layout_manager () |
| Undoes the effect of a previous call to set_layout_manager(). More... | |
| Glib::RefPtr< LayoutManager > | get_layout_manager () |
| Retrieves the layout manager set using set_layout_manager(). More... | |
| Glib::RefPtr< const LayoutManager > | get_layout_manager () const |
| Retrieves the layout manager set using set_layout_manager(). More... | |
| void | add_accelerator (const Glib::ustring& accel_signal, const Glib::RefPtr< AccelGroup >& accel_group, guint accel_key, Gdk::ModifierType accel_mods, AccelFlags accel_flags) |
| Installs an accelerator for this widget in accel_group that causes accel_signal to be emitted if the accelerator is activated. More... | |
| bool | remove_accelerator (const Glib::RefPtr< AccelGroup >& accel_group, guint accel_key, Gdk::ModifierType accel_mods) |
| Removes an accelerator from widget, previously installed with add_accelerator(). More... | |
| void | set_accel_path (const Glib::ustring& accel_path, const Glib::RefPtr< AccelGroup >& accel_group) |
| Given an accelerator group, accel_group, and an accelerator path, accel_path, sets up an accelerator in accel_group so whenever the key binding that is defined for accel_path is pressed, widget will be activated. More... | |
| bool | mnemonic_activate (bool group_cycling) |
| Emits the Gtk::Widget::signal_mnemonic_activate() signal. More... | |
| bool | event (const Glib::RefPtr< Gdk::Event >& gdk_event) |
| Rarely-used function. More... | |
| bool | activate () |
| For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. More... | |
| void | reparent (Container& new_parent) |
| Moves a widget from one Gtk::Container to another, handling reference count issues to avoid destroying the widget. More... | |
| void | set_can_focus (bool can_focus=true) |
| Specifies whether widget can own the input focus. More... | |
| bool | get_can_focus () const |
| Determines whether widget can own the input focus. More... | |
| bool | has_focus () const |
| Determines if the widget has the global input focus. More... | |
| bool | is_focus () const |
| Determines if the widget is the focus widget within its toplevel. More... | |
| bool | has_visible_focus () const |
| Determines if the widget should show a visible indication that it has the global input focus. More... | |
| bool | grab_focus () |
| Causes widget (or one of its descendents) to have the keyboard focus for the Gtk::Window it's inside. More... | |
| void | set_focus_on_click (bool focus_on_click=true) |
| Sets whether the widget should grab focus when it is clicked with the mouse. More... | |
| bool | get_focus_on_click () const |
| Returns whether the widget should grab focus when it is clicked with the mouse. More... | |
| void | set_can_target (bool can_target=true) |
| Sets whether widget can be the target of pointer events. More... | |
| bool | get_can_target () const |
| Queries whether widget can be the target of pointer events. More... | |
| bool | has_default () const |
| Determines whether widget is the current default widget within its toplevel. More... | |
| void | set_receives_default (bool receives_default=true) |
| 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. More... | |
| bool | get_receives_default () const |
| 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. More... | |
| bool | has_grab () const |
| Determines whether the widget is currently grabbing events, so it is the only widget receiving input events (keyboard and mouse). More... | |
| bool | device_is_shadowed (const Glib::RefPtr< const Gdk::Device >& device) |
Returns true if device has been shadowed by a GTK+ device grab on another widget, so it would stop sending events to widget. More... | |
| void | add_modal_grab () |
| Block events to everything else than this widget and its children. More... | |
| void | remove_modal_grab () |
| Remove the modal grab of the widget in case it was previously grabbed. More... | |
| void | set_name (const Glib::ustring& name) |
| Widgets can be named, which allows you to refer to them from a CSS file. More... | |
| void | unset_name () |
| Glib::ustring | get_name () const |
| Retrieves the name of a widget. More... | |
| void | set_state_flags (StateFlags flags, bool clear=true) |
| This function is for use in widget implementations. More... | |
| void | unset_state_flags (StateFlags flags) |
| This function is for use in widget implementations. More... | |
| StateFlags | get_state_flags () const |
| Returns the widget state as a flag set. More... | |
| void | set_sensitive (bool sensitive=true) |
| Sets the sensitivity of a widget. More... | |
| bool | get_sensitive () const |
| Returns the widget’s sensitivity (in the sense of returning the value that has been set using set_sensitive()). More... | |
| bool | is_sensitive () const |
| Returns the widget’s effective sensitivity, which means it is sensitive itself and also its parent widget is sensitive. More... | |
| void | set_visible (bool visible=true) |
| Sets the visibility state of widget. More... | |
| bool | get_visible () const |
| Determines whether the widget is visible. More... | |
| bool | is_visible () const |
| Determines whether the widget and all its parents are marked as visible. More... | |
| bool | get_is_drawable () const |
| Determines whether widget can be drawn to. More... | |
| bool | get_realized () const |
| Determines whether widget is realized. More... | |
| bool | get_mapped () const |
| Whether the widget is mapped. More... | |
| void | set_child_visible (bool visible=true) |
| Sets whether widget should be mapped along with its when its parent is mapped and widget has been shown with show(). More... | |
| bool | get_child_visible () const |
| Gets the value set with set_child_visible(). More... | |
| int | get_allocated_width () const |
| Returns the width that has currently been allocated to widget. More... | |
| int | get_allocated_height () const |
| Returns the height that has currently been allocated to widget. More... | |
| int | get_allocated_baseline () const |
| Returns the baseline that has currently been allocated to widget. More... | |
| Allocation | get_allocation () const |
| Retrieves the widget's location. More... | |
| int | get_width () const |
| Returns the content width of the widget, as passed to its size-allocate implementation. More... | |
| int | get_height () const |
| Returns the content height of the widget, as passed to its size-allocate implementation. More... | |
| Container* | get_parent () |
| Returns the parent widget of widget. More... | |
| const Container* | get_parent () const |
| Returns the parent widget of widget. More... | |
| Root* | get_root () |
Returns the Gtk::Root widget of widget or nullptr if the widget is not contained inside a widget tree with a root widget. More... | |
| const Root* | get_root () const |
Returns the Gtk::Root widget of widget or nullptr if the widget is not contained inside a widget tree with a root widget. More... | |
| Native* | get_native () |
Returns the GtkNative widget that contains widget, or nullptr if the widget is not contained inside a widget tree with a native ancestor. More... | |
| const Native* | get_native () const |
Returns the GtkNative widget that contains widget, or nullptr if the widget is not contained inside a widget tree with a native ancestor. More... | |
| bool | child_focus (DirectionType direction) |
| This function is used by custom widget implementations; if you're writing an app, you’d use grab_focus() to move the focus to a particular widget. More... | |
| bool | keynav_failed (DirectionType direction) |
| This function should be called whenever keyboard navigation within a single widget hits a boundary. More... | |
| void | error_bell () |
| Notifies the user about an input-related error on this widget. More... | |
| void | set_size_request (int width=-1, int height=-1) |
| Sets the minimum size of a widget; that is, the widget’s size request will be at least width by height. More... | |
| void | get_size_request (int& width, int& height) const |
| Gets the size request that was explicitly set for the widget using set_size_request(). More... | |
| void | set_opacity (double opacity) |
| Request the widget to be rendered partially transparent, with opacity 0 being fully transparent and 1 fully opaque. More... | |
| double | get_opacity () const |
| Fetches the requested opacity for this widget. More... | |
| void | set_overflow (Overflow overflow) |
| Sets how widget treats content that is drawn outside the widget's content area. More... | |
| Overflow | get_overflow () const |
| Returns the value set via set_overflow(). More... | |
| Widget* | get_ancestor (GType widget_type) |
| Gets the first ancestor of widget with type widget_type. More... | |
| const Widget* | get_ancestor (GType widget_type) const |
| Gets the first ancestor of widget with type widget_type. More... | |
| int | get_scale_factor () const |
| Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. More... | |
| Glib::RefPtr< Gdk::Display > | get_display () |
| Get the Gdk::Display for the toplevel window associated with this widget. More... | |
| Glib::RefPtr< const Gdk::Display > | get_display () const |
| Get the Gdk::Display for the toplevel window associated with this widget. More... | |
| Glib::RefPtr< Settings > | get_settings () |
| Gets the settings object holding the settings used for this widget. More... | |
| Glib::RefPtr< Gdk::Clipboard > | get_clipboard () |
| This is a utility function to get the clipboard object for the Gdk::Display that widget is using. More... | |
| Glib::RefPtr< const Gdk::Clipboard > | get_clipboard () const |
| This is a utility function to get the clipboard object for the Gdk::Display that widget is using. More... | |
| Glib::RefPtr< Gdk::Clipboard > | get_primary_clipboard () |
| This is a utility function to get the primary clipboard object for the Gdk::Display that widget is using. More... | |
| Glib::RefPtr< const Gdk::Clipboard > | get_primary_clipboard () const |
| This is a utility function to get the primary clipboard object for the Gdk::Display that widget is using. More... | |
| bool | get_hexpand () const |
| Gets whether the widget would like any available extra horizontal space. More... | |
| void | set_hexpand (bool expand=true) |
| Sets whether the widget would like any available extra horizontal space. More... | |
| bool | get_hexpand_set () const |
| Gets whether set_hexpand() has been used to explicitly set the expand flag on this widget. More... | |
| void | set_hexpand_set (bool set=true) |
| Sets whether the hexpand flag (see get_hexpand()) will be used. More... | |
| bool | get_vexpand () const |
| Gets whether the widget would like any available extra vertical space. More... | |
| void | set_vexpand (bool expand=true) |
| Sets whether the widget would like any available extra vertical space. More... | |
| bool | get_vexpand_set () const |
| Gets whether set_vexpand() has been used to explicitly set the expand flag on this widget. More... | |
| void | set_vexpand_set (bool set=true) |
| Sets whether the vexpand flag (see get_vexpand()) will be used. More... | |
| bool | compute_expand (Orientation orientation) |
| Computes whether a container should give this widget extra space when possible. More... | |
| void | set_expand (bool expand=true) |
| Sets whether the widget would like any available extra space in both directions. More... | |
| bool | get_support_multidevice () const |
Returns true if widget is multiple pointer aware. More... | |
| void | set_support_multidevice (bool support_multidevice=true) |
| Enables or disables multiple pointer awareness. More... | |
| Glib::RefPtr< Atk::Object > | get_accessible () |
| Returns the accessible object that describes the widget to an assistive technology. More... | |
| Glib::RefPtr< const Atk::Object > | get_accessible () const |
| Returns the accessible object that describes the widget to an assistive technology. More... | |
| Align | get_halign () const |
| Gets the value of the Gtk::Widget::property_halign() property. More... | |
| void | set_halign (Align align) |
| Sets the horizontal alignment of widget. More... | |
| Align | get_valign () const |
| Gets the value of the Gtk::Widget::property_valign() property. More... | |
| void | set_valign (Align align) |
| Sets the vertical alignment of widget. More... | |
| int | get_margin_start () const |
| Gets the value of the Gtk::Widget::property_margin_start() property. More... | |
| void | set_margin_start (int margin) |
| Sets the start margin of widget. More... | |
| int | get_margin_end () const |
| Gets the value of the Gtk::Widget::property_margin_end() property. More... | |
| void | set_margin_end (int margin) |
| Sets the end margin of widget. More... | |
| int | get_margin_top () const |
| Gets the value of the Gtk::Widget::property_margin_top() property. More... | |
| void | set_margin_top (int margin) |
| Sets the top margin of widget. More... | |
| int | get_margin_bottom () const |
| Gets the value of the Gtk::Widget::property_margin_bottom() property. More... | |
| void | set_margin_bottom (int margin) |
| Sets the bottom margin of widget. More... | |
| void | set_margin (int margin) |
| Set all 4 margins to the same value. More... | |
| bool | is_ancestor (Widget& ancestor) const |
| Determines whether widget is somewhere inside ancestor, possibly with intermediate containers. More... | |
| bool | translate_coordinates (Widget& dest_widget, int src_x, int src_y, int& dest_x, int& dest_y) |
| Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations. More... | |
| bool | contains (double x, double y) const |
| Tests if the point at ( x, y) is contained in widget. More... | |
| Widget* | pick (double x, double y, PickFlags flags=PickFlags::DEFAULT) |
| Finds the descendant of widget (including widget itself) closest to the screen at the point ( x, y). More... | |
| const Widget* | pick (double x, double y, PickFlags flags=PickFlags::DEFAULT) const |
| Finds the descendant of widget (including widget itself) closest to the screen at the point ( x, y). More... | |
| void | add_controller (const Glib::RefPtr< EventController >& controller) |
| Adds controller to widget so that it will receive events. More... | |
| void | remove_controller (const Glib::RefPtr< EventController >& controller) |
| Removes controller from widget, so that it doesn't process events anymore. More... | |
| void | reset_style () |
| Updates the style context of widget and all descendants by updating its widget path. More... | |
| Glib::RefPtr< Pango::Context > | create_pango_context () |
| Creates a new Pango::Context with the appropriate font map, font options, font description, and base direction for drawing text for this widget. More... | |
| Glib::RefPtr< Pango::Context > | get_pango_context () |
| Gets a Pango::Context with the appropriate font map, font description, and base direction for this widget. More... | |
| void | set_font_options (const Cairo::FontOptions& options) |
| Sets the #cairo_font_options_t used for Pango rendering in this widget. More... | |
| void | unset_font_options () |
| Undoes the effect of previous calls to set_font_options(). More... | |
| Cairo::FontOptions | get_font_options () const |
| Returns the #cairo_font_options_t used for Pango rendering. More... | |
| Glib::RefPtr< Pango::Layout > | create_pango_layout (const Glib::ustring& text) |
| Creates a new Pango::Layout with the appropriate font map, font description, and base direction for drawing text for this widget. More... | |
| void | set_direction (TextDirection dir) |
| Sets the reading direction on a particular widget. More... | |
| TextDirection | get_direction () const |
| Gets the reading direction for a particular widget. More... | |
| void | input_shape_combine_region (const Cairo::RefPtr< const Cairo::Region >& region) |
| Sets an input shape for this widget’s GDK surface. More... | |
| void | set_cursor (const Glib::RefPtr< Gdk::Cursor >& cursor) |
| Sets the cursor to be shown when pointer devices point towards widget. More... | |
| void | set_cursor (const Glib::ustring& name={}) |
| Sets a named cursor to be shown when pointer devices point towards the widget. More... | |
| Glib::RefPtr< Gdk::Cursor > | get_cursor () |
| Queries the cursor set via set_cursor(). More... | |
| Glib::RefPtr< const Gdk::Cursor > | get_cursor () const |
| Queries the cursor set via set_cursor(). More... | |
| std::vector< Widget* > | list_mnemonic_labels () |
| Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()). More... | |
| std::vector< const Widget* > | list_mnemonic_labels () const |
| Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()). More... | |
| void | add_mnemonic_label (Widget& label) |
| Adds a widget to the list of mnemonic labels for this widget. More... | |
| void | remove_mnemonic_label (Widget& label) |
| Removes a widget from the list of mnemonic labels for this widget. More... | |
| bool | drag_check_threshold (int start_x, int start_y, int current_x, int current_y) |
| Checks to see if a mouse drag starting at ( start_x, start_y) and ending at ( current_x, current_y) has passed the GTK drag threshold, and thus should trigger the beginning of a drag-and-drop operation. More... | |
| Glib::RefPtr< Gdk::FrameClock > | get_frame_clock () |
| Obtains the frame clock for a widget. More... | |
| Glib::RefPtr< const Gdk::FrameClock > | get_frame_clock () const |
| Obtains the frame clock for a widget. More... | |
| void | set_parent (Widget& parent) |
| This function is useful only when implementing subclasses of Gtk::Widget. More... | |
| void | unparent () |
| This function is only for use in widget implementations. More... | |
| void | map () |
| This function is only for use in widget implementations. More... | |
| void | unmap () |
| This function is only for use in widget implementations. More... | |
| void | trigger_tooltip_query () |
| Triggers a tooltip query on the display where the toplevel of widget is located. More... | |
| void | set_tooltip_text (const Glib::ustring& text) |
| Sets text as the contents of the tooltip. More... | |
| Glib::ustring | get_tooltip_text () const |
| Gets the contents of the tooltip for widget. More... | |
| void | set_tooltip_markup (const Glib::ustring& markup) |
| Sets markup as the contents of the tooltip, which is marked up with the Pango text markup language. More... | |
| Glib::ustring | get_tooltip_markup () const |
| Gets the contents of the tooltip for widget. More... | |
| void | set_has_tooltip (bool has_tooltip=TRUE) |
| Sets the has-tooltip property on widget to has_tooltip. More... | |
| bool | get_has_tooltip () const |
| Returns the current value of the has-tooltip property. More... | |
| bool | in_destruction () const |
| Returns whether the widget is currently being destroyed. More... | |
| Glib::RefPtr< StyleContext > | get_style_context () |
| Returns the style context associated to widget. More... | |
| Glib::RefPtr< const StyleContext > | get_style_context () const |
| Returns the style context associated to widget. More... | |
| Gdk::ModifierType | get_modifier_mask (Gdk::ModifierIntent intent) |
| Returns the modifier mask the widget’s windowing system backend uses for a particular purpose. More... | |
| guint | add_tick_callback (const SlotTick& slot) |
| Queues an animation frame update and adds a callback to be called before each frame. More... | |
| void | remove_tick_callback (guint id) |
| Removes a tick callback previously registered with add_tick_callback(). More... | |
| void | insert_action_group (const Glib::ustring& name, const Glib::RefPtr< Gio::ActionGroup >& group) |
| Inserts group into widget. More... | |
| void | remove_action_group (const Glib::ustring& name) |
| Removes a group from the widget. More... | |
| bool | activate_action (const Glib::ustring& name, const Glib::VariantBase& args) |
| Looks up the action in the action groups associated with the widget and its ancestors, and activates it. More... | |
| bool | activate_action (const Glib::ustring& name) |
| A activate_action() convenience overload. More... | |
| void | activate_default () |
| Activate the default.activate action from widget. More... | |
| void | set_font_map (const Glib::RefPtr< Pango::FontMap >& font_map) |
| Sets the font map to use for Pango rendering. More... | |
| Glib::RefPtr< Pango::FontMap > | get_font_map () |
| Gets the font map that has been set with set_font_map(). More... | |
| Glib::RefPtr< const Pango::FontMap > | get_font_map () const |
| Gets the font map that has been set with set_font_map(). More... | |
| Widget* | get_first_child () |
| const Widget* | get_first_child () const |
| Widget* | get_last_child () |
| const Widget* | get_last_child () const |
| Widget* | get_next_sibling () |
| const Widget* | get_next_sibling () const |
| Widget* | get_prev_sibling () |
| const Widget* | get_prev_sibling () const |
| Glib::RefPtr< Gio::ListModel > | observe_children () |
| Returns a ListModel to track the children of widget. More... | |
| Glib::RefPtr< const Gio::ListModel > | observe_children () const |
| Returns a ListModel to track the children of widget. More... | |
| Glib::RefPtr< Gio::ListModel > | observe_controllers () |
| Returns a ListModel to track the Gtk::EventControllers of widget. More... | |
| Glib::RefPtr< const Gio::ListModel > | observe_controllers () const |
| Returns a ListModel to track the Gtk::EventControllers of widget. More... | |
| void | insert_after (Widget& parent, const Widget& previous_sibling) |
| Inserts the Widget into the child widget list of parent after previous_sibling. More... | |
| void | insert_before (Widget& parent, const Widget& next_sibling) |
| Inserts the Widget into the child widget list of parent before next_sibling. More... | |
| void | insert_at_start (Widget& parent) |
| Inserts the Widget at the beginning of the child widget list of parent. More... | |
| void | insert_at_end (Widget& parent) |
| Inserts the Widget at the end of the child widget list of parent. More... | |
| void | snapshot_child (Widget& child, const Glib::RefPtr< Gtk::Snapshot >& snapshot) |
| When a widget receives a call to the snapshot function, it must send synthetic Gtk::Widget::signal_snapshot() calls to all children. More... | |
| bool | should_layout () const |
| Returns whether widget should contribute to the measuring and allocation of its parent. More... | |
| void | add_css_class (const Glib::ustring& css_class) |
| Adds css_class to widget. More... | |
| void | remove_css_class (const Glib::ustring& css_class) |
| Removes css_class from widget. More... | |
| bool | has_css_class (const Glib::ustring& css_class) const |
| Returns whether css_class is currently applied to widget. More... | |
| Glib::SignalProxy< void()> | signal_show () |
| Glib::SignalProxy< void()> | signal_hide () |
| Glib::SignalProxy< void()> | signal_map () |
| Emitted on mapping of a widget to the screen. More... | |
| Glib::SignalProxy< void()> | signal_unmap () |
| Glib::SignalProxy< void()> | signal_realize () |
| Emitted on realization of a widget. More... | |
| Glib::SignalProxy< void()> | signal_unrealize () |
| Glib::SignalProxy< void(int, int, int)> | signal_size_allocate () |
| Glib::SignalProxy< void(Gtk::StateFlags)> | signal_state_flags_changed () |
| Glib::SignalProxy< void(TextDirection)> | signal_direction_changed () |
| Glib::SignalProxy< void(bool)> | signal_grab_notify () |
| Glib::SignalProxy< bool(bool)> | signal_mnemonic_activate () |
| Glib::SignalProxy< void()> | signal_accel_closures_changed () |
| Glib::SignalProxy< bool()> | signal_popup_menu () |
| Glib::SignalProxy< bool(int, int, bool, const Glib::RefPtr< Tooltip >&)> | signal_query_tooltip () |
| Glib::PropertyProxy< Glib::ustring > | property_name () |
| The name of the widget. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_name () const |
| The name of the widget. More... | |
| Glib::PropertyProxy_ReadOnly< Container* > | property_parent () const |
| The parent widget of this widget. More... | |
| Glib::PropertyProxy_ReadOnly< Root* > | property_root () const |
The Gtk::Root widget of the widget tree containing this widget or nullptr if the widget is not contained in a root widget. More... | |
| Glib::PropertyProxy< int > | property_width_request () |
| Override for width request of the widget, or -1 if natural request should be used. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_width_request () const |
| Override for width request of the widget, or -1 if natural request should be used. More... | |
| Glib::PropertyProxy< int > | property_height_request () |
| Override for height request of the widget, or -1 if natural request should be used. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_height_request () const |
| Override for height request of the widget, or -1 if natural request should be used. More... | |
| Glib::PropertyProxy< bool > | property_visible () |
| Whether the widget is visible. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_visible () const |
| Whether the widget is visible. More... | |
| Glib::PropertyProxy< bool > | property_sensitive () |
| Whether the widget responds to input. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_sensitive () const |
| Whether the widget responds to input. More... | |
| Glib::PropertyProxy< bool > | property_can_focus () |
| Whether the widget can accept the input focus. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_can_focus () const |
| Whether the widget can accept the input focus. More... | |
| Glib::PropertyProxy< bool > | property_has_focus () |
| Whether the widget has the input focus. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_has_focus () const |
| Whether the widget has the input focus. More... | |
| Glib::PropertyProxy< bool > | property_is_focus () |
| Whether the widget is the focus widget within the toplevel. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_is_focus () const |
| Whether the widget is the focus widget within the toplevel. More... | |
| Glib::PropertyProxy< bool > | property_can_target () |
| Whether the widget can receive pointer events. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_can_target () const |
| Whether the widget can receive pointer events. More... | |
| Glib::PropertyProxy< bool > | property_focus_on_click () |
| Whether the widget should grab focus when it is clicked with the mouse. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_focus_on_click () const |
| Whether the widget should grab focus when it is clicked with the mouse. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_has_default () const |
| Whether the widget is the default widget. More... | |
| Glib::PropertyProxy< bool > | property_receives_default () |
If true, the widget will receive the default action when it is focused. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_receives_default () const |
If true, the widget will receive the default action when it is focused. More... | |
| Glib::PropertyProxy< Glib::RefPtr< Gdk::Cursor > > | property_cursor () |
| The cursor used by widget. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Cursor > > | property_cursor () const |
| The cursor used by widget. More... | |
| Glib::PropertyProxy< bool > | property_has_tooltip () |
| Enables or disables the emission of Gtk::Widget::signal_query_tooltip() on widget. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_has_tooltip () const |
| Enables or disables the emission of Gtk::Widget::signal_query_tooltip() on widget. More... | |
| Glib::PropertyProxy< Glib::ustring > | property_tooltip_markup () |
| Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_tooltip_markup () const |
| Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. More... | |
| Glib::PropertyProxy< Glib::ustring > | property_tooltip_text () |
| Sets the text of tooltip to be the given string. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_tooltip_text () const |
| Sets the text of tooltip to be the given string. More... | |
| Glib::PropertyProxy< Align > | property_halign () |
| How to distribute horizontal space if widget gets extra space, see Gtk::Align. More... | |
| Glib::PropertyProxy_ReadOnly< Align > | property_halign () const |
| How to distribute horizontal space if widget gets extra space, see Gtk::Align. More... | |
| Glib::PropertyProxy< Align > | property_valign () |
| How to distribute vertical space if widget gets extra space, see Gtk::Align. More... | |
| Glib::PropertyProxy_ReadOnly< Align > | property_valign () const |
| How to distribute vertical space if widget gets extra space, see Gtk::Align. More... | |
| Glib::PropertyProxy< int > | property_margin_start () |
| Margin on start of widget, horizontally. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_margin_start () const |
| Margin on start of widget, horizontally. More... | |
| Glib::PropertyProxy< int > | property_margin_end () |
| Margin on end of widget, horizontally. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_margin_end () const |
| Margin on end of widget, horizontally. More... | |
| Glib::PropertyProxy< int > | property_margin_top () |
| Margin on top side of widget. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_margin_top () const |
| Margin on top side of widget. More... | |
| Glib::PropertyProxy< int > | property_margin_bottom () |
| Margin on bottom side of widget. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_margin_bottom () const |
| Margin on bottom side of widget. More... | |
| Glib::PropertyProxy< int > | property_margin () |
| Sets all four sides' margin at once. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_margin () const |
| Sets all four sides' margin at once. More... | |
| Glib::PropertyProxy< bool > | property_hexpand () |
| Whether to expand horizontally. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_hexpand () const |
| Whether to expand horizontally. More... | |
| Glib::PropertyProxy< bool > | property_hexpand_set () |
| Whether to use the Gtk::Widget::property_hexpand() property. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_hexpand_set () const |
| Whether to use the Gtk::Widget::property_hexpand() property. More... | |
| Glib::PropertyProxy< bool > | property_vexpand () |
| Whether to expand vertically. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_vexpand () const |
| Whether to expand vertically. More... | |
| Glib::PropertyProxy< bool > | property_vexpand_set () |
| Whether to use the Gtk::Widget::property_vexpand() property. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_vexpand_set () const |
| Whether to use the Gtk::Widget::property_vexpand() property. More... | |
| Glib::PropertyProxy< bool > | property_expand () |
| Whether to expand in both directions. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_expand () const |
| Whether to expand in both directions. More... | |
| Glib::PropertyProxy< double > | property_opacity () |
| The requested opacity of the widget. More... | |
| Glib::PropertyProxy_ReadOnly< double > | property_opacity () const |
| The requested opacity of the widget. More... | |
| Glib::PropertyProxy< Overflow > | property_overflow () |
| How content outside the widget's content area is treated. More... | |
| Glib::PropertyProxy_ReadOnly< Overflow > | property_overflow () const |
| How content outside the widget's content area is treated. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_scale_factor () const |
| The scale factor of the widget. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_css_name () const |
| The name of this widget in the CSS tree. More... | |
| Glib::PropertyProxy< Glib::RefPtr< LayoutManager > > | property_layout_manager () |
| The Gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::RefPtr< LayoutManager > > | property_layout_manager () const |
| The Gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More... | |
Public Member Functions inherited from Gtk::Object | |
| Object (Object&& src) noexcept | |
| Object& | operator= (Object&& src) noexcept |
| ~Object () noexcept override | |
Public Member Functions inherited from Glib::Object | |
| Object (const Object &)=delete | |
| Object & | operator= (const Object &)=delete |
| Object (Object &&src) noexcept | |
| Object & | operator= (Object &&src) noexcept |
| void * | get_data (const QueryQuark &key) |
| void | set_data (const Quark &key, void *data) |
| void | set_data (const Quark &key, void *data, DestroyNotify notify) |
| void | remove_data (const QueryQuark &quark) |
| void * | steal_data (const QueryQuark &quark) |
| Glib::RefPtr< Glib::Object > | wrap (GObject *object, bool take_copy=false) |
Public Member Functions inherited from Glib::ObjectBase | |
| ObjectBase (const ObjectBase &)=delete | |
| ObjectBase & | operator= (const ObjectBase &)=delete |
| void | set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value) |
| void | get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const |
| void | set_property (const Glib::ustring &property_name, const PropertyType &value) |
| void | get_property (const Glib::ustring &property_name, PropertyType &value) const |
| PropertyType | get_property (const Glib::ustring &property_name) const |
| sigc::connection | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot) |
| sigc::connection | connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot) |
| void | freeze_notify () |
| void | thaw_notify () |
| virtual void | reference () const |
| virtual void | unreference () const |
| GObject * | gobj () |
| const GObject * | gobj () const |
| GObject * | gobj_copy () const |
Public Member Functions inherited from sigc::trackable | |
| trackable () noexcept | |
| trackable (const trackable &src) noexcept | |
| trackable (trackable &&src) noexcept | |
| ~trackable () | |
| void | add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const |
| void | notify_callbacks () |
| trackable & | operator= (const trackable &src) |
| trackable & | operator= (trackable &&src) noexcept |
| void | remove_destroy_notify_callback (notifiable *data) const |
Public Member Functions inherited from Gtk::Buildable | |
| Buildable (Buildable&& src) noexcept | |
| Buildable& | operator= (Buildable&& src) noexcept |
| ~Buildable () noexcept override | |
| GtkBuildable* | gobj () |
| Provides access to the underlying C GObject. More... | |
| const GtkBuildable* | gobj () const |
| Provides access to the underlying C GObject. More... | |
| void | set_name (const Glib::ustring& name) |
| Sets the name of the buildable object. More... | |
| Glib::ustring | get_name () const |
| Gets the name of the buildable object. More... | |
Public Member Functions inherited from Glib::Interface | |
| Interface () | |
| Interface (Interface &&src) noexcept | |
| Interface & | operator= (Interface &&src) noexcept |
| Interface (const Glib::Interface_Class &interface_class) | |
| Interface (GObject *castitem) | |
| ~Interface () noexcept override | |
| Interface (const Interface &)=delete | |
| Interface & | operator= (const Interface &)=delete |
| GObject * | gobj () |
| const GObject * | gobj () const |
Public Member Functions inherited from Gtk::ConstraintTarget | |
| ConstraintTarget (ConstraintTarget&& src) noexcept | |
| ConstraintTarget& | operator= (ConstraintTarget&& src) noexcept |
| ~ConstraintTarget () noexcept override | |
| GtkConstraintTarget* | gobj () |
| Provides access to the underlying C GObject. More... | |
| const GtkConstraintTarget* | gobj () const |
| Provides access to the underlying C GObject. More... | |
Public Member Functions inherited from Atk::Implementor | |
| Implementor (Implementor &&src) noexcept | |
| Implementor & | operator= (Implementor &&src) noexcept |
| ~Implementor () noexcept override | |
| AtkImplementor * | gobj () |
| const AtkImplementor * | gobj () const |
| Glib::RefPtr< Atk::Implementor > | wrap (AtkImplementor *object, bool take_copy=false) |
Static Public Member Functions | |
| static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. More... | |
Static Public Member Functions inherited from Gtk::Widget | |
| static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. More... | |
| static Widget* | get_current_modal_grab () |
| Retrieve the widget which is currently grabbing all events. More... | |
| static void | set_default_direction (TextDirection dir) |
| Sets the default reading direction for widgets where the direction has not been explicitly set by set_direction(). More... | |
| static TextDirection | get_default_direction () |
| Obtains the current default reading direction. More... | |
Static Public Member Functions inherited from Gtk::Buildable | |
| static void | add_interface (GType gtype_implementer) |
| static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. More... | |
Static Public Member Functions inherited from Gtk::ConstraintTarget | |
| static void | add_interface (GType gtype_implementer) |
| static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. More... | |
Static Public Member Functions inherited from Atk::Implementor | |
| static void | add_interface (GType gtype_implementer) |
| static GType | get_type () |
Related Functions | |
(Note that these are not member functions.) | |
| Gtk::Image* | wrap (GtkImage* object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Widget | |
| Gtk::Widget* | wrap (GtkWidget* object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Buildable | |
| Glib::RefPtr< Gtk::Buildable > | wrap (GtkBuildable* object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::ConstraintTarget | |
| Glib::RefPtr< Gtk::ConstraintTarget > | wrap (GtkConstraintTarget* object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from Gtk::Widget | |
| virtual void | root_vfunc () |
| virtual void | unroot_vfunc () |
| virtual SizeRequestMode | get_request_mode_vfunc () const |
| virtual void | measure_vfunc (Orientation orientation, int for_size, int& minimum, int& natural, int& minimum_baseline, int& natural_baseline) const |
| virtual bool | grab_focus_vfunc () |
| virtual Glib::RefPtr< Atk::Object > | get_accessible_vfunc () |
| virtual void | compute_expand_vfunc (bool& hexpand_p, bool& vexpand_p) |
| virtual bool | contains_vfunc (double x, double y) const |
| virtual void | snapshot_vfunc (const Glib::RefPtr< Gtk::Snapshot >& snapshot) |
| Widget () | |
| void | realize () |
| Creates the GDK (windowing system) resources associated with a widget. More... | |
| void | unrealize () |
| This function is only useful in widget implementations. More... | |
| void | realize_if_needed () |
| void | set_focus_child (Widget& child) |
| Set child as the current focus child of widget. More... | |
| void | unset_focus_child () |
| Unsets the focus child of the widget. More... | |
| Widget* | get_focus_child () |
| Returns the current focus child of widget. More... | |
| const Widget* | get_focus_child () const |
| Returns the current focus child of widget. More... | |
| virtual void | on_show () |
| This is a default handler for the signal signal_show(). More... | |
| virtual void | on_hide () |
| This is a default handler for the signal signal_hide(). More... | |
| virtual void | on_map () |
| This is a default handler for the signal signal_map(). More... | |
| virtual void | on_unmap () |
| This is a default handler for the signal signal_unmap(). More... | |
| virtual void | on_realize () |
| This is a default handler for the signal signal_realize(). More... | |
| virtual void | on_unrealize () |
| This is a default handler for the signal signal_unrealize(). More... | |
| virtual void | on_size_allocate (int width, int height, int baseline) |
| This is a default handler for the signal signal_size_allocate(). More... | |
| virtual void | on_state_flags_changed (Gtk::StateFlags previous_state_flags) |
| This is a default handler for the signal signal_state_flags_changed(). More... | |
| virtual void | on_direction_changed (TextDirection direction) |
| This is a default handler for the signal signal_direction_changed(). More... | |
| virtual void | on_grab_notify (bool was_grabbed) |
| This is a default handler for the signal signal_grab_notify(). More... | |
| virtual bool | on_mnemonic_activate (bool group_cycling) |
| This is a default handler for the signal signal_mnemonic_activate(). More... | |
| virtual bool | on_popup_menu () |
| This is a default handler for the signal signal_popup_menu(). More... | |
| virtual bool | on_query_tooltip (int x, int y, bool keyboard_tooltip, const Glib::RefPtr< Tooltip >& tooltip) |
| This is a default handler for the signal signal_query_tooltip(). More... | |
Protected Member Functions inherited from Glib::Object | |
| Object () | |
| Object (const Glib::ConstructParams &construct_params) | |
| Object (GObject *castitem) | |
| ~Object () noexcept override | |
Protected Member Functions inherited from Glib::ObjectBase | |
| ObjectBase () | |
| ObjectBase (const char *custom_type_name) | |
| ObjectBase (const std::type_info &custom_type_info) | |
| ObjectBase (ObjectBase &&src) noexcept | |
| ObjectBase & | operator= (ObjectBase &&src) noexcept |
| virtual | ~ObjectBase () noexcept=0 |
| void | initialize (GObject *castitem) |
| void | initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper) |
Protected Member Functions inherited from Gtk::Buildable | |
| Buildable () | |
| You should derive from this class to use it. More... | |
Protected Member Functions inherited from Gtk::ConstraintTarget | |
| ConstraintTarget () | |
| You should derive from this class to use it. More... | |
Protected Member Functions inherited from Atk::Implementor | |
| Implementor () | |
| virtual Glib::RefPtr< Object > | ref_accessibile_vfunc () |
A widget displaying an image.
The Gtk::Image widget displays an image. Various kinds of object can be displayed as an image; most typically, you would load a Gdk::Texture (which implements Gdk::Paintable) from a file, and then display that.
The Image widget looks like this:
|
noexcept |
|
delete |
|
overridenoexcept |
| Gtk::Image::Image | ( | ) |
|
explicit |
Creates an Image widget displaying the file filename.
If the file isn't found or can't be loaded, the resulting Gtk::Image will display a "broken image" icon.
If you need to detect failures to load the file, use Gdk::Pixbuf::create_from_file() to load the file yourself, then create the GtkImage from the pixbuf.
The storage type (get_storage_type()) of the returned image is not defined. It will be whatever is appropriate for displaying the file.
|
explicit |
Creates a new Image widget displaying pixbuf.
Note that this just creates an GtkImage from the pixbuf. The Gtk::Image created will not react to state changes. Should you want that, you should use the default constructor and set_from_icon_name().
|
explicit |
Creates a new Gtk::Image displaying paintable.
The Gtk::Image will track changes to the paintable and update its size and contents in response to it.
| paintable | A Gdk::Paintable, or an emtpy Glib::RefPtr. |
|
explicit |
Creates a Gtk::Image displaying an icon from the current icon theme.
If the icon name isn’t known, a “broken image” icon will be displayed instead. If the current icon theme is changed, the icon will be updated appropriately.
| icon | An icon. |
| void Gtk::Image::clear | ( | ) |
Resets the image to be empty.
| Glib::RefPtr<Gio::Icon> Gtk::Image::get_gicon | ( | ) |
Gets the Gio::Icon and size being displayed by the Gtk::Image.
The storage type of the image must be Gtk::Image::Type::EMPTY or Gtk::Image::Type::GICON (see get_storage_type()). The caller of this function does not own a reference to the returned Gio::Icon.
nullptr. | Glib::RefPtr<const Gio::Icon> Gtk::Image::get_gicon | ( | ) | const |
Gets the Gio::Icon and size being displayed by the Gtk::Image.
The storage type of the image must be Gtk::Image::Type::EMPTY or Gtk::Image::Type::GICON (see get_storage_type()). The caller of this function does not own a reference to the returned Gio::Icon.
nullptr. | Glib::ustring Gtk::Image::get_icon_name | ( | ) | const |
Gets the icon name and size being displayed by the Gtk::Image.
The storage type of the image must be Gtk::Image::Type::EMPTY or Gtk::Image::Type::ICON_NAME (see get_storage_type()). The returned string is owned by the Gtk::Image and should not be freed.
nullptr. | IconSize Gtk::Image::get_icon_size | ( | ) | const |
Gets the icon size used by the image when rendering icons.
| Glib::RefPtr<Gdk::Paintable> Gtk::Image::get_paintable | ( | ) |
Gets the image Gdk::Paintable being displayed by the Gtk::Image.
The storage type of the image must be Gtk::Image::Type::EMPTY or Gtk::Image::Type::PAINTABLE (see get_storage_type()). The caller of this function does not own a reference to the returned paintable.
nullptr if the image is empty. | Glib::RefPtr<const Gdk::Paintable> Gtk::Image::get_paintable | ( | ) | const |
Gets the image Gdk::Paintable being displayed by the Gtk::Image.
The storage type of the image must be Gtk::Image::Type::EMPTY or Gtk::Image::Type::PAINTABLE (see get_storage_type()). The caller of this function does not own a reference to the returned paintable.
nullptr if the image is empty. | int Gtk::Image::get_pixel_size | ( | ) | const |
Gets the pixel size used for named icons.
| Type Gtk::Image::get_storage_type | ( | ) | const |
Gets the type of representation being used by the Gtk::Image to store image data.
If the Gtk::Image has no image data, the return value will be Gtk::Image::Type::EMPTY.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
| Glib::PropertyProxy< Glib::ustring > Gtk::Image::property_file | ( | ) |
Filename to load and display.
Default value: ""
| Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Image::property_file | ( | ) | const |
Filename to load and display.
Default value: ""
| Glib::PropertyProxy< Glib::RefPtr<Gio::Icon> > Gtk::Image::property_gicon | ( | ) |
The GIcon displayed in the GtkImage.
For themed icons, If the icon theme is changed, the image will be updated automatically.
| Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gio::Icon> > Gtk::Image::property_gicon | ( | ) | const |
The GIcon displayed in the GtkImage.
For themed icons, If the icon theme is changed, the image will be updated automatically.
| Glib::PropertyProxy< Glib::ustring > Gtk::Image::property_icon_name | ( | ) |
The name of the icon in the icon theme.
If the icon theme is changed, the image will be updated automatically.
Default value: ""
| Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Image::property_icon_name | ( | ) | const |
The name of the icon in the icon theme.
If the icon theme is changed, the image will be updated automatically.
Default value: ""
| Glib::PropertyProxy< IconSize > Gtk::Image::property_icon_size | ( | ) |
Symbolic size to use for icon set or named icon.
Default value: Gtk::IconSize::INHERIT
| Glib::PropertyProxy_ReadOnly< IconSize > Gtk::Image::property_icon_size | ( | ) | const |
Symbolic size to use for icon set or named icon.
Default value: Gtk::IconSize::INHERIT
| Glib::PropertyProxy< Glib::RefPtr<Gdk::Paintable> > Gtk::Image::property_paintable | ( | ) |
A GdkPaintable to display.
| Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Paintable> > Gtk::Image::property_paintable | ( | ) | const |
A GdkPaintable to display.
| Glib::PropertyProxy< int > Gtk::Image::property_pixel_size | ( | ) |
The "pixel-size" property can be used to specify a fixed size overriding the Gtk::Image::property_icon_size() property for images of type Gtk::Image::Type::ICON_NAME.
Default value: -1
| Glib::PropertyProxy_ReadOnly< int > Gtk::Image::property_pixel_size | ( | ) | const |
The "pixel-size" property can be used to specify a fixed size overriding the Gtk::Image::property_icon_size() property for images of type Gtk::Image::Type::ICON_NAME.
Default value: -1
| Glib::PropertyProxy< std::string > Gtk::Image::property_resource | ( | ) |
A path to a resource file to display.
Default value: ""
| Glib::PropertyProxy_ReadOnly< std::string > Gtk::Image::property_resource | ( | ) | const |
A path to a resource file to display.
Default value: ""
| Glib::PropertyProxy_ReadOnly< Type > Gtk::Image::property_storage_type | ( | ) | const |
The representation being used for image data.
Default value: Gtk::Image::Type::EMPTY
| Glib::PropertyProxy< bool > Gtk::Image::property_use_fallback | ( | ) |
Whether the icon displayed in the GtkImage will use standard icon names fallback.
The value of this property is only relevant for images of type Gtk::Image::Type::ICON_NAME and Gtk::Image::Type::GICON.
Default value: false
| Glib::PropertyProxy_ReadOnly< bool > Gtk::Image::property_use_fallback | ( | ) | const |
Whether the icon displayed in the GtkImage will use standard icon names fallback.
The value of this property is only relevant for images of type Gtk::Image::Type::ICON_NAME and Gtk::Image::Type::GICON.
Default value: false
| void Gtk::Image::set | ( | const std::string & | filename | ) |
See the Image::Image(const std::string& file) constructor for details.
| filename | A filename. |
| void Gtk::Image::set | ( | const Glib::RefPtr< Gdk::Pixbuf >& | pixbuf | ) |
See the Image::Image(const Glib::RefPtr<Gdk::Pixbuf>& pixbuf) constructor for details.
| pixbuf | A Gdk::Pixbuf. |
| void Gtk::Image::set | ( | const Glib::RefPtr< Gdk::Paintable >& | paintable | ) |
See new_from_paintable() for details.
| paintable | A Gdk::Paintable or nullptr. |
| void Gtk::Image::set | ( | const Glib::RefPtr< const Gio::Icon > & | icon | ) |
See new_from_gicon() for details.
| icon | An icon. |
| void Gtk::Image::set_from_icon_name | ( | const Glib::ustring & | icon_name | ) |
Causes the Image to display an icon from the current icon theme.
If the icon name isn't known, a "broken image" icon will be displayed instead. If the current icon theme is changed, the icon will be updated appropriately.
| icon_name | An icon name or nullptr. |
| void Gtk::Image::set_from_resource | ( | const std::string & | resource_path | ) |
See new_from_resource() for details.
| resource_path | A resource path or nullptr. |
| void Gtk::Image::set_icon_size | ( | IconSize | icon_size | ) |
Suggests an icon size to the theme for named icons.
| icon_size | The new icon size. |
| void Gtk::Image::set_pixel_size | ( | int | pixel_size | ) |
Sets the pixel size to use for named icons.
If the pixel size is set to a value != -1, it is used instead of the icon size set by set_from_icon_name().
| pixel_size | The new pixel size. |
|
related |
A Glib::wrap() method for this object.
| object | The C instance. |
| take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |
1.8.11