gtkmm  3.6.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions
Gtk::IconFactory Class Reference
Inheritance diagram for Gtk::IconFactory:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~IconFactory ()
GtkIconFactory* gobj ()
 Provides access to the underlying C GObject.
const GtkIconFactory* gobj () const
 Provides access to the underlying C GObject.
GtkIconFactory* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
void add (const Gtk::StockID& stock_id, const Glib::RefPtr< IconSet >& icon_set)
 Adds the given icon_set to the icon factory, under the name stock_id.
void add_default ()
 Adds an icon factory to the list of icon factories searched by Gtk::Style::lookup_icon_set().
void remove_default ()
 Removes an icon factory from the list of default icon factories.
- Public Member Functions inherited from Glib::Object
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)
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
void connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot)
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot)
void freeze_notify ()
void thaw_notify ()
virtual void reference () const
virtual void unreference () const
GObject * gobj_copy () const
Glib::RefPtr< Glib::Objectwrap (GObject *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.
static Glib::RefPtr< IconFactorycreate ()

Protected Member Functions

 IconFactory ()
- Protected Member Functions inherited from Glib::Object
 Object ()
 Object (const Glib::ConstructParams &construct_params)
 Object (GObject *castitem)
virtual ~Object ()
 ObjectBase ()
 ObjectBase (const char *custom_type_name)
 ObjectBase (const std::type_info &custom_type_info)
virtual ~ObjectBase ()=0
void initialize (GObject *castitem)

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gtk::IconFactorywrap (GtkIconFactory* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Additional Inherited Members

- Public Types inherited from Glib::Object
typedef void(* DestroyNotify )(gpointer data)

Constructor & Destructor Documentation

virtual Gtk::IconFactory::~IconFactory ( )
virtual
Gtk::IconFactory::IconFactory ( )
protected

Member Function Documentation

void Gtk::IconFactory::add ( const Gtk::StockID stock_id,
const Glib::RefPtr< IconSet >&  icon_set 
)

Adds the given icon_set to the icon factory, under the name stock_id.

stock_id should be namespaced for your application, e.g. "myapp-whatever-icon". Normally applications create a Gtk::IconFactory, then add it to the list of default factories with add_default(). Then they pass the stock_id to widgets such as Gtk::Image to display the icon. Themes can provide an icon with the same name (such as "myapp-whatever-icon") to override your application's default icons. If an icon already existed in factory for stock_id, it is unreferenced and replaced with the new icon_set.

Parameters:
stock_idIcon name.
icon_setIcon set.
void Gtk::IconFactory::add_default ( )

Adds an icon factory to the list of icon factories searched by Gtk::Style::lookup_icon_set().

This means that, for example, the Image::Image(const Gtk::StockID& stock_id, IconSize size) constructor will be able to find icons in factory. There will normally be an icon factory added for each library or application that comes with icons. The default icon factories can be overridden by themes.

static Glib::RefPtr<IconFactory> Gtk::IconFactory::create ( )
static
static GType Gtk::IconFactory::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

GtkIconFactory* Gtk::IconFactory::gobj ( )
inline

Provides access to the underlying C GObject.

Reimplemented from Glib::Object.

const GtkIconFactory* Gtk::IconFactory::gobj ( ) const
inline

Provides access to the underlying C GObject.

Reimplemented from Glib::Object.

GtkIconFactory* Gtk::IconFactory::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

void Gtk::IconFactory::remove_default ( )

Removes an icon factory from the list of default icon factories.

Not normally used; you might use it for a library that can be unloaded or shut down.


Friends And Related Function Documentation

Glib::RefPtr< Gtk::IconFactory > wrap ( GtkIconFactory *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters:
objectThe C instance.
take_copyFalse 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.

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