glibmm  2.42.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gio::EmblemedIcon Class Reference

Icons with Emblems. More...

#include <giomm/emblemedicon.h>

Inheritance diagram for Gio::EmblemedIcon:
Inheritance graph
[legend]

Public Member Functions

virtual ~EmblemedIcon ()
 
GEmblemedIcon* gobj ()
 Provides access to the underlying C GObject. More...
 
const GEmblemedIcon* gobj () const
 Provides access to the underlying C GObject. More...
 
GEmblemedIcon* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
Glib::RefPtr< Iconget_icon ()
 Gets the main icon for emblemed. More...
 
Glib::RefPtr< const Iconget_icon () const
 Gets the main icon for emblemed. More...
 
Glib::ListHandle< Glib::RefPtr
< Emblem > > 
get_emblems ()
 Gets the list of emblems for the icon. More...
 
void add_emblem (const Glib::RefPtr< Emblem >& emblem)
 Adds emblem to the List of Emblems. More...
 
void clear_emblems ()
 Removes all the emblems from icon. More...
 
- 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)
 
- Public Member Functions inherited from Glib::ObjectBase
void set_property_value (const Glib::ustring& property_name, const Glib::ValueBase& value)
 You probably want to use a specific property_*() accessor method instead. More...
 
void get_property_value (const Glib::ustring& property_name, Glib::ValueBase& value) const
 You probably want to use a specific property_*() accessor method instead. More...
 
template<class PropertyType >
void set_property (const Glib::ustring& property_name, const PropertyType& value)
 You probably want to use a specific property_*() accessor method instead. More...
 
template<class PropertyType >
void get_property (const Glib::ustring& property_name, PropertyType& value) const
 You probably want to use a specific property_*() accessor method instead. More...
 
void connect_property_changed (const Glib::ustring& property_name, const sigc::slot< void >& slot)
 You can use the signal_changed() signal of the property proxy instead, but this is necessary when using the reduced API. More...
 
sigc::connection connect_property_changed_with_return (const Glib::ustring& property_name, const sigc::slot< void >& slot)
 You can use the signal_changed() signal of the property proxy instead, but this is necessary when using the reduced API. More...
 
void freeze_notify ()
 Increases the freeze count on object. More...
 
void thaw_notify ()
 Reverts the effect of a previous call to freeze_notify(). More...
 
virtual void reference () const
 Increment the reference count for this object. More...
 
virtual void unreference () const
 Decrement the reference count for this object. More...
 
GObject* gobj ()
 Provides access to the underlying C GObject. More...
 
const GObject* gobj () const
 Provides access to the underlying C GObject. More...
 
GObject* gobj_copy () const
 Give a ref-ed copy to someone. Use for direct struct access. More...
 
- Public Member Functions inherited from Gio::Icon
virtual ~Icon ()
 
GIcon* gobj ()
 Provides access to the underlying C GObject. More...
 
const GIcon* gobj () const
 Provides access to the underlying C GObject. More...
 
guint hash () const
 Gets a hash for an icon. More...
 
std::string to_string () const
 Generates a textual representation of icon that can be used for serialization such as when passing icon to a different process or saving it to persistent storage. More...
 
bool equal (const Glib::RefPtr< Icon >& other) const
 
- Public Member Functions inherited from Glib::Interface
 Interface ()
 A Default constructor. More...
 
 Interface (const Glib::Interface_Class& interface_class)
 Called by constructors of derived classes. More...
 
 Interface (GObject* castitem)
 Called by constructors of derived classes. More...
 
virtual ~Interface ()
 
GObject* gobj ()
 
const GObject* gobj () const
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
static Glib::RefPtr< EmblemedIconcreate (const Glib::RefPtr< Icon >& icon, const Glib::RefPtr< Emblem >& emblem)
 Creates a new emblemed icon for icon with the emblem emblem. More...
 
static Glib::RefPtr< EmblemedIconcreate (const Glib::RefPtr< Icon >& icon)
 Creates a new emblemed icon for icon with no emblem. More...
 
- Static Public Member Functions inherited from Gio::Icon
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 Glib::RefPtr< Iconcreate (const std::string& str)
 

Protected Member Functions

 EmblemedIcon (const Glib::RefPtr< Icon >& icon)
 Creates a new emblemed icon for icon with no emblem. More...
 
 EmblemedIcon (const Glib::RefPtr< Icon >& icon, const Glib::RefPtr< Emblem >& emblem)
 Creates a new emblemed icon for icon with the emblem emblem. More...
 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams& construct_params)
 
 Object (GObject* castitem)
 
virtual ~Object ()
 
- Protected Member Functions inherited from Glib::ObjectBase
 ObjectBase ()
 This default constructor is called implicitly from the constructor of user-derived classes, even if, for instance, Gtk::Button calls a different ObjectBase constructor. More...
 
 ObjectBase (const char* custom_type_name)
 A derived constructor always overrides this choice. More...
 
 ObjectBase (const std::type_info& custom_type_info)
 This constructor is a special feature to allow creation of derived types on the fly, without having to use g_object_new() manually. More...
 
virtual ~ObjectBase ()=0
 
void initialize (GObject* castitem)
 
- Protected Member Functions inherited from Gio::Icon
 Icon ()
 You should derive from this class to use it. More...
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gio::EmblemedIconwrap (GEmblemedIcon* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Additional Inherited Members

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

Detailed Description

Icons with Emblems.

EmblemedIcon is an implementation of Icon that supports adding an emblem to an icon. Adding multiple emblems to an icon is ensured via add_emblem().

Note that EmblemedIcon allows no control over the position of the emblems. See also Emblem for more information.

Since glibmm 2.20:

Constructor & Destructor Documentation

virtual Gio::EmblemedIcon::~EmblemedIcon ( )
virtual
Gio::EmblemedIcon::EmblemedIcon ( const Glib::RefPtr< Icon >&  icon)
explicitprotected

Creates a new emblemed icon for icon with no emblem.

Parameters
iconAn Icon.
Since glibmm 2.28:
Gio::EmblemedIcon::EmblemedIcon ( const Glib::RefPtr< Icon >&  icon,
const Glib::RefPtr< Emblem >&  emblem 
)
explicitprotected

Creates a new emblemed icon for icon with the emblem emblem.

Parameters
iconAn Icon.
emblemAn Emblem.

Member Function Documentation

void Gio::EmblemedIcon::add_emblem ( const Glib::RefPtr< Emblem >&  emblem)

Adds emblem to the List of Emblems.

Since glibmm 2.18:
Parameters
emblemA Emblem.
void Gio::EmblemedIcon::clear_emblems ( )

Removes all the emblems from icon.

Since glibmm 2.28:
static Glib::RefPtr<EmblemedIcon> Gio::EmblemedIcon::create ( const Glib::RefPtr< Icon >&  icon,
const Glib::RefPtr< Emblem >&  emblem 
)
static

Creates a new emblemed icon for icon with the emblem emblem.

Parameters
iconAn Icon.
emblemAn Emblem.
Returns
An Icon.
static Glib::RefPtr<EmblemedIcon> Gio::EmblemedIcon::create ( const Glib::RefPtr< Icon >&  icon)
static

Creates a new emblemed icon for icon with no emblem.

Parameters
iconAn Icon.
Returns
An Icon.
Since glibmm 2.28:
Glib::ListHandle<Glib::RefPtr<Emblem> > Gio::EmblemedIcon::get_emblems ( )

Gets the list of emblems for the icon.

Since glibmm 2.18:
Returns
A List of Emblems that is owned by emblemed.
Glib::RefPtr<Icon> Gio::EmblemedIcon::get_icon ( )

Gets the main icon for emblemed.

Since glibmm 2.18:
Returns
A Icon that is owned by emblemed.
Glib::RefPtr<const Icon> Gio::EmblemedIcon::get_icon ( ) const

Gets the main icon for emblemed.

Since glibmm 2.18:
Returns
A Icon that is owned by emblemed.
static GType Gio::EmblemedIcon::get_type ( )
static

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

GEmblemedIcon* Gio::EmblemedIcon::gobj ( )
inline

Provides access to the underlying C GObject.

const GEmblemedIcon* Gio::EmblemedIcon::gobj ( ) const
inline

Provides access to the underlying C GObject.

GEmblemedIcon* Gio::EmblemedIcon::gobj_copy ( )

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

Friends And Related Function Documentation

Glib::RefPtr< Gio::EmblemedIcon > wrap ( GEmblemedIcon *  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.