#include <iconinfo.h>
Definition at line 43 of file iconinfo.h.
◆ IconInfo() [1/4]
| Gtk::IconInfo::IconInfo |
( |
| ) |
|
◆ IconInfo() [2/4]
| Gtk::IconInfo::IconInfo |
( |
GtkIconInfo * |
gobject, |
|
|
bool |
make_a_copy = true |
|
) |
| |
|
explicit |
◆ IconInfo() [3/4]
| Gtk::IconInfo::IconInfo |
( |
const IconInfo & |
other | ) |
|
◆ ~IconInfo()
| Gtk::IconInfo::~IconInfo |
( |
| ) |
|
◆ IconInfo() [4/4]
| Gtk::IconInfo::IconInfo |
( |
const Glib::RefPtr< IconTheme > & |
icon_theme, |
|
|
const Glib::RefPtr< Gdk::Pixbuf > & |
pixbuf |
|
) |
| |
◆ get_attach_points()
| bool Gtk::IconInfo::get_attach_points |
( |
Glib::ArrayHandle< Gdk::Point > & |
points | ) |
const |
◆ get_base_size()
| int Gtk::IconInfo::get_base_size |
( |
| ) |
const |
Gets the base size for the icon. The base size is a size for the icon that was specified by the icon theme creator. This may be different than the actual size of image; an example of this is small emblem icons that can be attached to a larger icon. These icons will be given the same base size as the larger icons to which they are attached.
- Returns
- The base size, or 0, if no base size is known for the icon.
◆ get_builtin_pixbuf() [1/2]
| Glib::RefPtr<Gdk::Pixbuf> Gtk::IconInfo::get_builtin_pixbuf |
( |
| ) |
|
◆ get_builtin_pixbuf() [2/2]
| Glib::RefPtr<const Gdk::Pixbuf> Gtk::IconInfo::get_builtin_pixbuf |
( |
| ) |
const |
◆ get_display_name()
| Glib::ustring Gtk::IconInfo::get_display_name |
( |
| ) |
const |
Gets the display name for an icon. A display name is a string to be used in place of the icon name in a user visible context like a list of icons.
- Returns
- The display name for the icon or
0, if the icon doesn't have a specified display name. This value is owned icon_info and must not be modified or free.
◆ get_embedded_rect()
| bool Gtk::IconInfo::get_embedded_rect |
( |
Gdk::Rectangle & |
rectangle | ) |
const |
Gets the coordinates of a rectangle within the icon that can be used for display of information such as a preview of the contents of a text file. See set_raw_coordinates() for further information about the coordinate system.
- Parameters
-
| rectangle | Gdk::Rectangle in which to store embedded rectangle coordinates; coordinates are only stored when this function returns true. |
- Returns
true if the icon has an embedded rectangle.
◆ get_filename()
| Glib::ustring Gtk::IconInfo::get_filename |
( |
| ) |
const |
◆ get_type()
| static GType Gtk::IconInfo::get_type |
( |
| ) |
|
|
static |
Get the GType for this class, for use with the underlying GObject type system.
◆ gobj() [1/2]
Provides access to the underlying C instance.
Definition at line 67 of file iconinfo.h.
◆ gobj() [2/2]
Provides access to the underlying C instance.
Definition at line 70 of file iconinfo.h.
◆ gobj_copy()
Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
◆ load_icon()
| Glib::RefPtr<Gdk::Pixbuf> Gtk::IconInfo::load_icon |
( |
| ) |
const |
Renders an icon previously looked up in an icon theme using Gtk::IconTheme::lookup_icon(); the size will be based on the size passed to Gtk::IconTheme::lookup_icon(). Note that the resulting pixbuf may not be exactly this size; an icon theme may have icons that differ slightly from their nominal sizes, and in addition GTK+ will avoid scaling icons that it considers sufficiently close to the requested size or for which the source image would have to be scaled up too far. (This maintains sharpness.). This behaviour can be changed by passing the Gtk::ICON_LOOKUP_FORCE_SIZE flag when obtaining the Gtk::IconInfo. If this flag has been specified, the pixbuf returned by this function will be scaled to the exact size.
- Returns
- The rendered icon; this may be a newly created icon or a new reference to an internal icon, so you must not modify the icon. Use Glib::object_unref() to release your reference to the icon.
◆ operator bool() [1/2]
| Gtk::IconInfo::operator bool |
( |
| ) |
|
◆ operator bool() [2/2]
| Gtk::IconInfo::operator bool |
( |
| ) |
const |
◆ operator=()
◆ set_raw_coordinates()
| void Gtk::IconInfo::set_raw_coordinates |
( |
bool |
raw_coordinates = true | ) |
|
Sets whether the coordinates returned by get_embedded_rect() and get_attach_points() should be returned in their original form as specified in the icon theme, instead of scaled appropriately for the pixbuf returned by load_icon().
Raw coordinates are somewhat strange; they are specified to be with respect to the unscaled pixmap for PNG and XPM icons, but for SVG icons, they are in a 1000x1000 coordinate space that is scaled to the final size of the icon. You can determine if the icon is an SVG icon by using get_filename(), and seeing if it is non-0 and ends in '.svg'.
This function is provided primarily to allow compatibility wrappers for older API's, and is not expected to be useful for applications.
- Parameters
-
| raw_coordinates | Whether the coordinates of embedded rectangles and attached points should be returned in their original (unscaled) form. |
◆ swap()
| void Gtk::IconInfo::swap |
( |
IconInfo & |
other | ) |
|
◆ swap()
- Parameters
-
| lhs | The left-hand side |
| rhs | The right-hand side |
Definition at line 220 of file iconinfo.h.
◆ wrap()
A Glib::wrap() method for this object.
- Parameters
-
| 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. |
- Returns
- A C++ instance that wraps this C instance.
◆ gobject_
The documentation for this class was generated from the following file:
1.9.1