glibmm: Gio::CharsetConverter Class Reference
CharsetConverter - Convert between charsets. More...
#include <giomm/charsetconverter.h>
Public Member Functions | |
CharsetConverter (CharsetConverter&& src) noexcept | |
CharsetConverter& | operator= (CharsetConverter&& src) noexcept |
~CharsetConverter () noexcept override | |
GCharsetConverter* | gobj () |
Provides access to the underlying C GObject. More... | |
const GCharsetConverter* | gobj () const |
Provides access to the underlying C GObject. More... | |
GCharsetConverter* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
void | set_use_fallback (bool use_fallback) |
Sets the CharsetConverter::property_use_fallback() property. More... | |
bool | get_use_fallback () const |
Gets the CharsetConverter::property_use_fallback() property. More... | |
guint | get_num_fallbacks () const |
Gets the number of fallbacks that converter has applied so far. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_from_charset () const |
The character encoding to convert from. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_to_charset () const |
The character encoding to convert to. More... | |
Glib::PropertyProxy< bool > | property_use_fallback () |
Use fallback (of form \<hexval>) for invalid bytes. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_use_fallback () const |
Use fallback (of form \<hexval>) for invalid bytes. More... | |
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 (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 | |
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. 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 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::Converter | |
Converter (Converter&& src) noexcept | |
Converter& | operator= (Converter&& src) noexcept |
~Converter () noexcept override | |
GConverter* | gobj () |
Provides access to the underlying C GObject. More... | |
const GConverter* | gobj () const |
Provides access to the underlying C GObject. More... | |
Result | convert (const void* inbuf, gsize inbuf_size, void* outbuf, gsize outbuf_size, Flags flags, gsize& bytes_read, gsize& bytes_written) |
This is the main operation used when converting data. More... | |
void | reset () |
Resets all internal state in the converter, making it behave as if it was just created. More... | |
Public Member Functions inherited from Glib::Interface | |
Interface () | |
A Default constructor. More... | |
Interface (Interface&& src) noexcept | |
Interface& | operator= (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 | |
Interface& | operator= (const Interface&)=delete |
GObject* | gobj () |
const GObject* | gobj () const |
Public Member Functions inherited from Gio::Initable | |
Initable (Initable&& src) noexcept | |
Initable& | operator= (Initable&& src) noexcept |
~Initable () noexcept override | |
GInitable* | gobj () |
Provides access to the underlying C GObject. More... | |
const GInitable* | gobj () const |
Provides access to the underlying C GObject. 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< CharsetConverter > | create (const Glib::ustring& to_charset, const Glib::ustring& from_charset) |
Creates a new CharsetConverter. More... | |
Static Public Member Functions inherited from Gio::Converter | |
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 Public Member Functions inherited from Gio::Initable | |
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 | |
CharsetConverter (const Glib::ustring& to_charset, const Glib::ustring& from_charset) | |
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 | |
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::Converter | |
Converter () | |
You should derive from this class to use it. More... | |
virtual Result | convert_vfunc (const void* inbuf, gsize inbuf_size, void* outbuf, gsize outbuf_size, Flags flags, gsize& bytes_read, gsize& bytes_written) |
virtual void | reset_vfunc () |
Protected Member Functions inherited from Gio::Initable | |
Initable () | |
You should derive from this class to use it. More... | |
void | init (const Glib::RefPtr< Cancellable >& cancellable) |
Initializes the object implementing the interface. More... | |
void | init () |
A init() convenience overload. More... | |
virtual bool | init_vfunc (const Glib::RefPtr< Cancellable >& cancellable, GError** error) |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gio::CharsetConverter > | wrap (GCharsetConverter* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Glib::Object | |
Glib::RefPtr< Glib::Object > | wrap (GObject* object, bool take_copy=false) |
Related Functions inherited from Gio::Converter | |
Glib::RefPtr< Gio::Converter > | wrap (GConverter* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gio::Initable | |
Glib::RefPtr< Gio::Initable > | wrap (GInitable* 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) |
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 |
Public Types inherited from Gio::Converter |
Detailed Description
CharsetConverter - Convert between charsets.
CharsetConverter is an implementation of Converter based on GIConv.
Constructor & Destructor Documentation
|
noexcept |
|
overridenoexcept |
|
explicitprotected |
Member Function Documentation
|
static |
Creates a new CharsetConverter.
- Parameters
-
to_charset Destination charset. from_charset Source charset.
- Returns
- A new CharsetConverter, or
nullptr
on error.
- Exceptions
-
Gio::Error
guint Gio::CharsetConverter::get_num_fallbacks | ( | ) | const |
Gets the number of fallbacks that converter has applied so far.
- Returns
- The number of fallbacks that converter has applied.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
bool Gio::CharsetConverter::get_use_fallback | ( | ) | const |
Gets the CharsetConverter::property_use_fallback() property.
- Returns
true
if fallbacks are used by converter.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
GCharsetConverter* Gio::CharsetConverter::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
|
noexcept |
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gio::CharsetConverter::property_from_charset | ( | ) | const |
The character encoding to convert from.
Default value: ""
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gio::CharsetConverter::property_to_charset | ( | ) | const |
The character encoding to convert to.
Default value: ""
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gio::CharsetConverter::property_use_fallback | ( | ) |
Use fallback (of form \<hexval>) for invalid bytes.
Default value: false
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gio::CharsetConverter::property_use_fallback | ( | ) | const |
Use fallback (of form \<hexval>) for invalid bytes.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gio::CharsetConverter::set_use_fallback | ( | bool | use_fallback | ) |
Sets the CharsetConverter::property_use_fallback() property.
- Parameters
-
use_fallback true
to use fallbacks.
Friends And Related Function Documentation
|
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.