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:

Public Member Functions
	FileIcon (FileIcon &&src) noexcept
FileIcon &	operator= (FileIcon &&src) noexcept
	~FileIcon () noexcept override
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< File >	get_file ()
	Gets the File associated with the given icon.
Glib::RefPtr< const File >	get_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
	Object (const Object &)=delete
Object &	operator= (const Object &)=delete
	Object (Object &&src) noexcept
Object &	operator= (Object &&src) noexcept
void *	get_data (const QueryQuark & key)
void	set_data (const Quark & key, void *data)
void	set_data_with_c_callback (const Quark & key, void *data, GDestroyNotify notify)
void	set_data (const Quark & key, void *data, DestroyNotify notify)
	Prefer set_data_with_c_callback() with a callback with C linkage.
void	remove_data (const QueryQuark &quark)
void *	steal_data (const QueryQuark &quark)
Public Member Functions inherited from Glib::ObjectBase
	ObjectBase (const ObjectBase &)=delete
ObjectBase &	operator= (const ObjectBase &)=delete
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.
template<class PropertyType >
PropertyType	get_property (const Glib::ustring & property_name) const
	You probably want to use a specific property_*() accessor method instead.
sigc::connection	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.
sigc::connection	connect_property_changed (const Glib::ustring & property_name, sigc::slot< void()> && slot)
	You can use the signal_changed() signal of the property proxy instead.
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 ()
	Provides access to the underlying C GObject.
const GObject *	gobj () const
	Provides access to the underlying C GObject.
GObject *	gobj_copy () const
	Give a ref-ed copy to someone. Use for direct struct access.
Public Member Functions inherited from sigc::trackable
	trackable () noexcept
	trackable (const trackable &src) noexcept
	trackable (trackable &&src) noexcept
	~trackable ()
void	add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const
void	notify_callbacks ()
trackable &	operator= (const trackable &src)
trackable &	operator= (trackable &&src) noexcept
void	remove_destroy_notify_callback (notifiable *data) const
Public Member Functions inherited from Gio::Icon
	Icon (Icon &&src) noexcept
Icon &	operator= (Icon &&src) noexcept
	~Icon () noexcept override
GIcon *	gobj ()
	Provides access to the underlying C GObject.
const GIcon *	gobj () const
	Provides access to the underlying C GObject.
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
Glib::VariantBase	serialize () const
	Serializes a Icon into a Variant.
Public Member Functions inherited from Glib::Interface
	Interface ()
	A Default constructor.
	Interface (Interface &&src) noexcept
Interface &	operator= (Interface &&src) noexcept
	Interface (const Glib::Interface_Class &interface_class)
	Called by constructors of derived classes.
	Interface (GObject *castitem)
	Called by constructors of derived classes.
	~Interface () noexcept override
	Interface (const Interface &)=delete
Interface &	operator= (const Interface &)=delete
GObject *	gobj ()
const GObject *	gobj () const
Public Member Functions inherited from Gio::LoadableIcon
	LoadableIcon (LoadableIcon &&src) noexcept
LoadableIcon &	operator= (LoadableIcon &&src) noexcept
	~LoadableIcon () noexcept override
GLoadableIcon *	gobj ()
	Provides access to the underlying C GObject.
const GLoadableIcon *	gobj () const
	Provides access to the underlying C GObject.
Glib::RefPtr< InputStream >	load (int size, Glib::ustring & type, const Glib::RefPtr< Cancellable > &cancellable)
	Loads a loadable icon.
Glib::RefPtr< InputStream >	load (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()

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< FileIcon >	create ()
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.
static Glib::RefPtr< Icon >	create (const std::string & str)
	Generate an Icon instance from str.
static Glib::RefPtr< Icon >	deserialize (const Glib::VariantBase & value)
	Deserializes a Icon previously serialized using g_icon_serialize().
Static Public Member Functions inherited from Gio::LoadableIcon
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.

Protected Member Functions
	FileIcon ()
Protected Member Functions inherited from Glib::Object
	Object ()
	Object (const Glib::ConstructParams &construct_params)
	Object (GObject *castitem)
	~Object () noexcept override
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.
	ObjectBase (ObjectBase &&src) noexcept
ObjectBase &	operator= (ObjectBase &&src) noexcept
virtual	~ObjectBase () noexcept=0
void	initialize (GObject *castitem)
void	initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)
Protected Member Functions inherited from Gio::Icon
	Icon ()
	You should derive from this class to use it.
Protected Member Functions inherited from Gio::LoadableIcon
	LoadableIcon ()
	You should derive from this class to use it.

Related Symbols
(Note that these are not member symbols.)
Glib::RefPtr< Gio::FileIcon >	wrap (GFileIcon *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Glib::Object
Glib::RefPtr< Glib::Object >	wrap (GObject *object, bool take_copy=false)
Related Symbols inherited from Gio::Icon
Glib::RefPtr< Gio::Icon >	wrap (GIcon *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Gio::LoadableIcon
Glib::RefPtr< Gio::LoadableIcon >	wrap (GLoadableIcon *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Additional Inherited Members
Public Types inherited from Glib::Object
using	DestroyNotify = void(*)(gpointer data)
Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify	func_destroy_notify
Public Types inherited from sigc::notifiable
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

FileIcon() [1/2]

Gio::FileIcon::FileIcon ( FileIcon &&  src )

noexcept

~FileIcon()

Gio::FileIcon::~FileIcon ( )

overridenoexcept

FileIcon() [2/2]

Gio::FileIcon::FileIcon ( )

protected

Member Function Documentation

create()

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

static

get_file() [1/2]

Glib::RefPtr< File > Gio::FileIcon::get_file

(

)

Gets the File associated with the given icon.

Returns

A File.

get_file() [2/2]

Glib::RefPtr< const File > Gio::FileIcon::get_file

(

)

const

Gets the File associated with the given icon.

Returns

A File.

get_type()

static GType Gio::FileIcon::get_type ( )

static

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

gobj() [1/2]

GFileIcon * Gio::FileIcon::gobj ( )

inline

Provides access to the underlying C GObject.

gobj() [2/2]

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

inline

Provides access to the underlying C GObject.

gobj_copy()

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.

operator=()

FileIcon & Gio::FileIcon::operator= ( FileIcon &&  src )

noexcept

property_file()

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< File > > Gio::FileIcon::property_file

(

)

const

The file containing the icon.

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 Symbol Documentation

wrap()

Glib::RefPtr< Gio::FileIcon > wrap ( GFileIcon *  object, bool  take_copy = false  )

related

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.