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

TlsPassword - TLS Passwords for prompting. More...

#include <giomm/tlspassword.h>

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

Public Member Functions

virtual ~TlsPassword ()
 
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...
 
TlsPasswordFlags get_flags () const
 Get flags about the password. More...
 
void set_flags (TlsPasswordFlags 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::ustring
property_description ()
 Description of what the password is for. More...
 
Glib::PropertyProxy_ReadOnly
< Glib::ustring
property_description () const
 Description of what the password is for. More...
 
Glib::PropertyProxy
< TlsPasswordFlags
property_flags ()
 Flags about the password. More...
 
Glib::PropertyProxy_ReadOnly
< TlsPasswordFlags
property_flags () const
 Flags about the password. More...
 
Glib::PropertyProxy
< Glib::ustring
property_warning ()
 Warning about the password. More...
 
Glib::PropertyProxy_ReadOnly
< Glib::ustring
property_warning () const
 Warning about the password. More...
 
virtual const guchar* get_value_vfunc (gsize& length) const
 
virtual Glib::ustring get_default_warning_vfunc () const
 
- 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. 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...
 
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. More...
 
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. 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...
 

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, TlsPasswordFlags flags=Gio::TLS_PASSWORD_NONE)
 Create a new TlsPassword object. More...
 

Protected Member Functions

 TlsPassword (const Glib::ustring& description, TlsPasswordFlags flags=Gio::TLS_PASSWORD_NONE)
 
- 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. 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...
 
virtual ~ObjectBase ()=0
 
void initialize (GObject* castitem)
 

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...
 

Additional Inherited Members

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

Detailed Description

TlsPassword - TLS Passwords for prompting.

Holds a password used in TLS.

Since glibmm 2.36:

Constructor & Destructor Documentation

virtual Gio::TlsPassword::~TlsPassword ( )
virtual
Gio::TlsPassword::TlsPassword ( const Glib::ustring description,
TlsPasswordFlags  flags = Gio::TLS_PASSWORD_NONE 
)
explicitprotected

Member Function Documentation

static Glib::RefPtr<TlsPassword> Gio::TlsPassword::create ( const Glib::ustring description,
TlsPasswordFlags  flags = Gio::TLS_PASSWORD_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
virtual
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.
TlsPasswordFlags 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 0 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 0 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
virtual
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.

Glib::PropertyProxy< Glib::ustring > Gio::TlsPassword::property_description ( )

Description of what the password is for.

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

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.

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.
Glib::PropertyProxy< TlsPasswordFlags > Gio::TlsPassword::property_flags ( )

Flags about the password.

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

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

Flags about the password.

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

Warning about the password.

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

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.

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.
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 ( TlsPasswordFlags  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.