Ardour  9.0-pre0-582-g084a23a80d
Gtk::IconSize Class Reference

#include <enums.h>

Public Member Functions

 IconSize ()
 
 IconSize (BuiltinIconSize size)
 
 IconSize (int size)
 
 operator int () const
 

Static Public Member Functions

static bool lookup (IconSize size, int &width, int &height)
 
static bool lookup (IconSize size, int &width, int &height, const Glib::RefPtr< Gtk::Settings > &settings)
 
static IconSize register_new (const Glib::ustring &name, int width, int height)
 
static void register_alias (const Glib::ustring &alias, IconSize target)
 
static IconSize from_name (const Glib::ustring &name)
 
static Glib::ustring get_name (IconSize size)
 

Private Attributes

int size_
 

Detailed Description

Represents registered icon sizes. You can also use a Gtk::BuiltinIconSize instead of an IconSize.

Definition at line 1656 of file libs/tk/ytkmm/ytkmm/gtkmm/enums.h.

Constructor & Destructor Documentation

◆ IconSize() [1/3]

Gtk::IconSize::IconSize ( )
inline

Definition at line 1662 of file libs/tk/ytkmm/ytkmm/gtkmm/enums.h.

◆ IconSize() [2/3]

Gtk::IconSize::IconSize ( BuiltinIconSize  size)
inline

Definition at line 1663 of file libs/tk/ytkmm/ytkmm/gtkmm/enums.h.

◆ IconSize() [3/3]

Gtk::IconSize::IconSize ( int  size)
inlineexplicit

Definition at line 1666 of file libs/tk/ytkmm/ytkmm/gtkmm/enums.h.

Member Function Documentation

◆ from_name()

static IconSize Gtk::IconSize::from_name ( const Glib::ustring &  name)
static

Looks up the icon size associated with name.

Parameters
namethe name to look up. result The icon size with the given name.

◆ get_name()

static Glib::ustring Gtk::IconSize::get_name ( IconSize  size)
static

Gets the canonical name of the given icon size.

Parameters
sizesize AnIconSize.
Returns
The name of the given icon size.

◆ lookup() [1/2]

static bool Gtk::IconSize::lookup ( IconSize  size,
int &  width,
int &  height 
)
static

Obtains the pixel size of a semantic icon size, possibly modified by user preferences for the default Gtk::Settings. Normally size would be Gtk::ICON_SIZE_MENU, Gtk::ICON_SIZE_BUTTON, etc. This function isn't normally needed because Gtk::Widget::render_icon() is the usual way to get an icon for rendering - then just look at the size of the rendered pixbuf. The rendered pixbuf may not even correspond to the width/height returned by IconSize::lookup(), because themes are free to render the pixbuf however they like, including changing the usual size.

Parameters
sizeAn icon size.
widthLocation to store icon width.
heightLocation to store icon height.
Returns
true if size was a valid size.

◆ lookup() [2/2]

static bool Gtk::IconSize::lookup ( IconSize  size,
int &  width,
int &  height,
const Glib::RefPtr< Gtk::Settings > &  settings 
)
static

Obtains the pixel size of a semantic icon size, possibly modified by user preferences for a particular Gtk::Settings. Normally size would be Gtk::ICON_SIZE_MENU, Gtk::ICON_SIZE_BUTTON, etc. This function isn't normally needed because Gtk::Widget::render_icon() is the usual way to get an icon for rendering - then just look at the size of the rendered pixbuf. The rendered pixbuf may not even correspond to the width/height returned by IconSize::lookup(), because themes are free to render the pixbuf however they like, including changing the usual size.

Parameters
sizeAn icon size.
widthLocation to store icon width.
heightLocation to store icon height.
settingsA Gtk::Settings object, used to determine which set of user preferences to used.
Returns
true if size was a valid size.

◆ operator int()

Gtk::IconSize::operator int ( ) const
inline

Definition at line 1667 of file libs/tk/ytkmm/ytkmm/gtkmm/enums.h.

◆ register_alias()

static void Gtk::IconSize::register_alias ( const Glib::ustring &  alias,
IconSize  target 
)
static

Registers alias as another name for target so calling from_name() with alias as argument will return target.

Parameters
aliasAn alias for target.
targetAn existing icon size.

◆ register_new()

static IconSize Gtk::IconSize::register_new ( const Glib::ustring &  name,
int  width,
int  height 
)
static

Registers a new icon size, along the same lines as ICON_SIZE_MENU, etc. Returns the integer value for the size.

Parameters
nameName of the icon size.
widthThe icon width.
heightThe icon height.
Returns
Integer value representing the size.

Member Data Documentation

◆ size_

int Gtk::IconSize::size_
private

Definition at line 1659 of file libs/tk/ytkmm/ytkmm/gtkmm/enums.h.


The documentation for this class was generated from the following file: