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

An icon stored in memory as a Glib::Bytes. More...

#include <giomm/bytesicon.h>

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

Public Member Functions

 BytesIcon (BytesIcon && src) noexcept
 
BytesIconoperator= (BytesIcon && src) noexcept
 
 ~BytesIcon () noexcept override
 
GBytesIcon * gobj ()
 Provides access to the underlying C GObject. More...
 
const GBytesIcon * gobj () const
 Provides access to the underlying C GObject. More...
 
GBytesIcon * 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< const Glib::Bytesget_bytes () const
 Gets the Bytes associated with the given icon. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Glib::Bytes > > property_bytes () const
 The bytes containing the icon. More...
 
- Public Member Functions inherited from Glib::Object
 Object (const Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object && src) noexcept
 
Objectoperator= (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. More...
 
void remove_data (const QueryQuark & quark)
 
void * steal_data (const QueryQuark & quark)
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (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. 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...
 
template<class PropertyType >
PropertyType get_property (const Glib::ustring & property_name) const
 You probably want to use a specific property_*() accessor method instead. More...
 
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. More...
 
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. 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
 Icon (Icon && src) noexcept
 
Iconoperator= (Icon && src) noexcept
 
 ~Icon () noexcept override
 
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
 
Glib::VariantBase serialize () const
 Serializes a Icon into a Variant. More...
 
- Public Member Functions inherited from Glib::Interface
 Interface ()
 A Default constructor. More...
 
 Interface (Interface && src) noexcept
 
Interfaceoperator= (Interface && src) noexcept
 
 Interface (const Glib::Interface_Class & interface_class)
 Called by constructors of derived classes. More...
 
 Interface (GObject * castitem)
 Called by constructors of derived classes. More...
 
 ~Interface () noexcept override
 
 Interface (const Interface &)=delete
 
Interfaceoperator= (const Interface &)=delete
 
GObject * gobj ()
 
const GObject * gobj () const
 
- Public Member Functions inherited from Gio::LoadableIcon
 LoadableIcon (LoadableIcon && src) noexcept
 
LoadableIconoperator= (LoadableIcon && src) noexcept
 
 ~LoadableIcon () noexcept override
 
GLoadableIcon * gobj ()
 Provides access to the underlying C GObject. More...
 
const GLoadableIcon * gobj () const
 Provides access to the underlying C GObject. More...
 
Glib::RefPtr< InputStreamload (int size, Glib::ustring & type, const Glib::RefPtr< Cancellable > & cancellable)
 Loads a loadable icon. More...
 
Glib::RefPtr< InputStreamload (int size, Glib::ustring & type)
 Non-cancellable version of load() More...
 
void load_async (int size, const SlotAsyncReady & slot, const Glib::RefPtr< Cancellable > & cancellable)
 Loads an icon asynchronously. More...
 
void load_async (int size, const SlotAsyncReady & slot)
 Non-cancellable version of load_async() More...
 

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< BytesIconcreate (const Glib::RefPtr< const Glib::Bytes > & bytes)
 Creates a new icon for a Glib::Bytes. 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)
 Generate an Icon instance from str. More...
 
static Glib::RefPtr< Icondeserialize (const Glib::VariantBase & value)
 Deserializes a Icon previously serialized using g_icon_serialize(). More...
 
- 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. More...
 

Protected Member Functions

 BytesIcon (const Glib::RefPtr< const Glib::Bytes > & bytes)
 
- 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. 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...
 
 ObjectBase (ObjectBase && src) noexcept
 
ObjectBaseoperator= (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. More...
 
- Protected Member Functions inherited from Gio::LoadableIcon
 LoadableIcon ()
 You should derive from this class to use it. More...
 

Related Functions

(Note that these are not member functions.)

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

Additional Inherited Members

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

Detailed Description

An icon stored in memory as a Glib::Bytes.

Gio::BytesIcon specifies an image held in memory in a common format (usually png) to be used as icon.

See also
Icon, LoadableIcon, Glib::Bytes
Since glibmm 2.76:

Constructor & Destructor Documentation

◆ BytesIcon() [1/2]

Gio::BytesIcon::BytesIcon ( BytesIcon &&  src)
noexcept

◆ ~BytesIcon()

Gio::BytesIcon::~BytesIcon ( )
overridenoexcept

◆ BytesIcon() [2/2]

Gio::BytesIcon::BytesIcon ( const Glib::RefPtr< const Glib::Bytes > &  bytes)
explicitprotected

Member Function Documentation

◆ create()

static Glib::RefPtr< BytesIcon > Gio::BytesIcon::create ( const Glib::RefPtr< const Glib::Bytes > &  bytes)
static

Creates a new icon for a Glib::Bytes.

This cannot fail, but loading and interpreting the bytes may fail later on (for example, if Gio::LoadableIcon::load() is called) if the image is invalid.

Since glibmm 2.76:
Parameters
bytesA Glib::Bytes.
Returns
A Icon for the given bytes.

◆ get_bytes()

Glib::RefPtr< const Glib::Bytes > Gio::BytesIcon::get_bytes ( ) const

Gets the Bytes associated with the given icon.

Since glibmm 2.76:
Returns
A Bytes.

◆ get_type()

static GType Gio::BytesIcon::get_type ( )
static

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

◆ gobj() [1/2]

GBytesIcon * Gio::BytesIcon::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GBytesIcon * Gio::BytesIcon::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GBytesIcon * Gio::BytesIcon::gobj_copy ( )

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

◆ operator=()

BytesIcon & Gio::BytesIcon::operator= ( BytesIcon &&  src)
noexcept

◆ property_bytes()

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Glib::Bytes > > Gio::BytesIcon::property_bytes ( ) const

The bytes containing the icon.

Since glibmm 2.76:
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

◆ wrap()

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