glibmm: Gio::TlsPassword Class Reference

TlsPassword - TLS Passwords for prompting. More...

#include </home/kjell/checkout/gnome/glibmm/gio/giomm/tlspassword.h>

Inheritance diagram for Gio::TlsPassword:

Public Types

- 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 Member Functions

 TlsPassword (TlsPassword&& src) noexcept
 
TlsPasswordoperator= (TlsPassword&& src) noexcept
 
 ~TlsPassword () noexcept override
 
GTlsPassword* gobj ()
 Provides access to the underlying C GObject. More...

 
const GTlsPassword* gobj () const
 Provides access to the underlying C GObject. More...

 
GTlsPassword* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

 
const guchar* get_value (gsize& length) const
 Get the password value. More...

 
const guchar* get_value () const
 A get_value() convenience overload. More...

 
void set_value (const guchar* value, gssize length=-1)
 Set the value for this password. More...

 
Glib::ustring get_description () const
 Get a description string about what the password will be used for. More...

 
void set_description (const Glib::ustring& description)
 Set a description string about what the password will be used for. More...

 
Flags get_flags () const
 Get flags about the password. More...

 
void set_flags (Flags flags)
 Set flags about the password. More...

 
Glib::ustring get_warning () const
 Get a user readable translated warning. More...

 
void set_warning (const Glib::ustring& warning)
 Set a user readable translated warning. More...

 
Glib::PropertyProxy< Glib::ustringproperty_description ()
 Description of what the password is for. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_description () const
 Description of what the password is for. More...

 
Glib::PropertyProxy< Flagsproperty_flags ()
 Flags about the password. More...

 
Glib::PropertyProxy_ReadOnly< Flagsproperty_flags () const
 Flags about the password. More...

 
Glib::PropertyProxy< Glib::ustringproperty_warning ()
 Warning about the password. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_warning () const
 Warning about the password. 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 (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
 
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 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 ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src) noexcept
 
void remove_destroy_notify_callback (notifiable *data) 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< TlsPasswordcreate (const Glib::ustring& description, Flags flags=Flags::NONE)
 Create a new TlsPassword object. More...

 

Protected Member Functions

 TlsPassword (const Glib::ustring& description, Flags flags=Flags::NONE)
 
virtual const guchar* get_value_vfunc (gsize& length) const
 
virtual Glib::ustring get_default_warning_vfunc () const
 
- 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)
 

Related Functions

(Note that these are not member functions.)

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

 

Detailed Description

TlsPassword - TLS Passwords for prompting.

Holds a password used in TLS.

Since glibmm 2.36:

Constructor & Destructor Documentation

Gio::TlsPassword::TlsPassword ( TlsPassword&&  src)
noexcept
Gio::TlsPassword::~TlsPassword ( )
overridenoexcept
Gio::TlsPassword::TlsPassword ( const Glib::ustring description,
Flags  flags = Flags::NONE 
)
explicitprotected

Member Function Documentation

static Glib::RefPtr<TlsPassword> Gio::TlsPassword::create ( const Glib::ustring description,
Flags  flags = Flags::NONE 
)
static

Create a new TlsPassword object.

Parameters
flagsThe password flags.
descriptionDescription of what the password is for.
Returns
The newly allocated password object.
virtual Glib::ustring Gio::TlsPassword::get_default_warning_vfunc ( ) const
protectedvirtual
Glib::ustring Gio::TlsPassword::get_description ( ) const

Get a description string about what the password will be used for.

Since glibmm 2.30:
Returns
The description of the password.
Flags Gio::TlsPassword::get_flags ( ) const

Get flags about the password.

Since glibmm 2.30:
Returns
The flags about the password.
static GType Gio::TlsPassword::get_type ( )
static

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

const guchar* Gio::TlsPassword::get_value ( gsize &  length) const

Get the password value.

If length is not nullptr then it will be filled in with the length of the password value. (Note that the password value is not nul-terminated, so you can only pass nullptr for length in contexts where you know the password will have a certain fixed length.)

Since glibmm 2.30:
Parameters
lengthLocation to place the length of the password.
Returns
The password value (owned by the password object).
const guchar* Gio::TlsPassword::get_value ( ) const

A get_value() convenience overload.

virtual const guchar* Gio::TlsPassword::get_value_vfunc ( gsize &  length) const
protectedvirtual
Glib::ustring Gio::TlsPassword::get_warning ( ) const

Get a user readable translated warning.

Usually this warning is a representation of the password flags returned from g_tls_password_get_flags().

Since glibmm 2.30:
Returns
The warning.
GTlsPassword* Gio::TlsPassword::gobj ( )
inline

Provides access to the underlying C GObject.

const GTlsPassword* Gio::TlsPassword::gobj ( ) const
inline

Provides access to the underlying C GObject.

GTlsPassword* Gio::TlsPassword::gobj_copy ( )

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

TlsPassword& Gio::TlsPassword::operator= ( TlsPassword&&  src)
noexcept
Glib::PropertyProxy< Glib::ustring > Gio::TlsPassword::property_description ( )

Description of what the password is for.

Default value: ""

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< Glib::ustring > Gio::TlsPassword::property_description ( ) const

Description of what the password is for.

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< Flags > Gio::TlsPassword::property_flags ( )

Flags about the password.

Default value: Gio::TlsPassword::Flags::NONE

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< Flags > Gio::TlsPassword::property_flags ( ) const

Flags about the password.

Default value: Gio::TlsPassword::Flags::NONE

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< Glib::ustring > Gio::TlsPassword::property_warning ( )

Warning about the password.

Default value: ""

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< Glib::ustring > Gio::TlsPassword::property_warning ( ) const

Warning about the password.

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.
void Gio::TlsPassword::set_description ( const Glib::ustring description)

Set a description string about what the password will be used for.

Since glibmm 2.30:
Parameters
descriptionThe description of the password.
void Gio::TlsPassword::set_flags ( Flags  flags)

Set flags about the password.

Since glibmm 2.30:
Parameters
flagsThe flags about the password.
void Gio::TlsPassword::set_value ( const guchar *  value,
gssize  length = -1 
)

Set the value for this password.

The value will be copied by the password object.

Specify the length, for a non-nul-terminated password. Pass -1 as length if using a nul-terminated password, and length will be calculated automatically. (Note that the terminating nul is not considered part of the password in this case.)

Since glibmm 2.30:
Parameters
valueThe new password value.
lengthThe length of the password, or -1.
void Gio::TlsPassword::set_warning ( const Glib::ustring warning)

Set a user readable translated warning.

Usually this warning is a representation of the password flags returned from g_tls_password_get_flags().

Since glibmm 2.30:
Parameters
warningThe user readable warning.

Friends And Related Function Documentation

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