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

FileIcon specifies an icon by pointing to an image file to be used as icon. More...

#include <giomm/fileicon.h>

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

Public Member Functions

virtual ~FileIcon ()
GFileIcon* gobj ()
 Provides access to the underlying C GObject.
const GFileIcon* gobj () const
 Provides access to the underlying C GObject.
GFileIcon* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::RefPtr< Fileget_file ()
 Gets the File associated with the given icon.
Glib::RefPtr< const Fileget_file () const
 Gets the File associated with the given icon.
Glib::PropertyProxy_ReadOnly
< Glib::RefPtr< File > > 
property_file () const
 The file containing the icon.
- 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.
void get_property_value (const Glib::ustring& property_name, Glib::ValueBase&value) const
 You probably want to use a specific property_*() accessor method instead.
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.
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.
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.
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.
void freeze_notify ()
 Increases the freeze count on object.
void thaw_notify ()
 Reverts the effect of a previous call to freeze_notify().
virtual void reference () const
 Increment the reference count for this object.
virtual void unreference () const
 Decrement the reference count for this object.
GObject* gobj_copy () const
 Give a ref-ed copy to someone. Use for direct struct access.
- Public Member Functions inherited from sigc::trackable
 trackable ()
 trackable (const trackable &src)
 ~trackable ()
void add_destroy_notify_callback (void *data, func_destroy_notify func) const
void notify_callbacks ()
trackableoperator= (const trackable &src)
void remove_destroy_notify_callback (void *data) const
- Public Member Functions inherited from Gio::LoadableIcon
virtual ~LoadableIcon ()
Glib::RefPtr< InputStreamload (int size, Glib::ustring& type, const Glib::RefPtr< Cancellable >& cancellable)
 Loads a loadable icon.
Glib::RefPtr< InputStreamload (int size, Glib::ustring& type)
 Non-cancellable version of load()
void load_async (int size, const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable)
 Loads an icon asynchronously.
void load_async (int size, const SlotAsyncReady& slot)
 Non-cancellable version of load_async()
- Public Member Functions inherited from Gio::Icon
virtual ~Icon ()
guint hash () const
 Gets a hash for an icon.
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.
bool equal (const Glib::RefPtr< Icon >& other) const
- Public Member Functions inherited from Glib::Interface
 Interface (const Glib::Interface_Class& interface_class)
 Called by constructors of derived classes.
 Interface (GObject* castitem)
 Called by constructors of derived classes.
virtual ~Interface ()

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< FileIconcreate ()
- Static Public Member Functions inherited from Gio::LoadableIcon
static void add_interface (GType gtype_implementer)
- Static Public Member Functions inherited from Gio::Icon
static Glib::RefPtr< Iconcreate (const std::string& str)

Protected Member Functions

 FileIcon ()
- 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.
 ObjectBase (const char* custom_type_name)
 A derived constructor always overrides this choice.
 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.
virtual ~ObjectBase ()=0
void initialize (GObject* castitem)
- Protected Member Functions inherited from Gio::LoadableIcon
 LoadableIcon ()
 You should derive from this class to use it.
- Protected Member Functions inherited from Gio::Icon
 Icon ()
 You should derive from this class to use it.

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gio::FileIconwrap (GFileIcon* 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)
- Public Types inherited from sigc::trackable
typedef
internal::func_destroy_notify 
func_destroy_notify

Detailed Description

FileIcon specifies an icon by pointing to an image file to be used as icon.

Since glibmm 2.16:

Constructor & Destructor Documentation

virtual Gio::FileIcon::~FileIcon ( )
virtual
Gio::FileIcon::FileIcon ( )
protected

Member Function Documentation

static Glib::RefPtr<FileIcon> Gio::FileIcon::create ( )
static
Glib::RefPtr<File> Gio::FileIcon::get_file ( )

Gets the File associated with the given icon.

Returns
A File, or 0.
Glib::RefPtr<const File> Gio::FileIcon::get_file ( ) const

Gets the File associated with the given icon.

Returns
A File, or 0.
static GType Gio::FileIcon::get_type ( )
static

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

Reimplemented from Gio::LoadableIcon.

GFileIcon* Gio::FileIcon::gobj ( )
inline

Provides access to the underlying C GObject.

Reimplemented from Gio::LoadableIcon.

const GFileIcon* Gio::FileIcon::gobj ( ) const
inline

Provides access to the underlying C GObject.

Reimplemented from Gio::LoadableIcon.

GFileIcon* Gio::FileIcon::gobj_copy ( )

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

Glib::PropertyProxy_ReadOnly< Glib::RefPtr<File> > Gio::FileIcon::property_file ( ) const

The file containing the icon.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

Friends And Related Function Documentation

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