glibmm: Gio::SettingsSchemaKey Class Reference
See SettingsSchema . More...
#include <giomm/settingsschemakey.h>
Public Member Functions |
|
void | reference () const |
Increment the reference count for this object.
More...
|
|
void | unreference () const |
Decrement the reference count for this object.
More...
|
|
GSettingsSchemaKey* | gobj () |
Provides access to the underlying C instance.
More...
|
|
const GSettingsSchemaKey* | gobj () const |
Provides access to the underlying C instance.
More...
|
|
GSettingsSchemaKey* | gobj_copy () const |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
More...
|
|
SettingsSchemaKey ()=delete | |
SettingsSchemaKey (const SettingsSchemaKey &)=delete | |
SettingsSchemaKey & | operator= (const SettingsSchemaKey &)=delete |
Glib::ustring | get_name () const |
Gets the name of
key
.
More...
|
|
Glib::ustring | get_summary () const |
Gets the summary for
key
.
More...
|
|
Glib::ustring | get_description () const |
Gets the description for
key
.
More...
|
|
Protected Member Functions |
|
void | operator delete (void*, std::size_t) |
Related Functions |
|
(Note that these are not member functions.) |
|
Glib::RefPtr < Gio::SettingsSchemaKey > | wrap (GSettingsSchemaKey* object, bool take_copy=false) |
A
Glib::wrap()
method for this object.
More...
|
|
Detailed Description
Constructor & Destructor Documentation
|
delete |
|
delete |
Member Function Documentation
Glib::ustring Gio::SettingsSchemaKey::get_description | ( | ) | const |
Gets the description for key .
If no description has been provided in the schema for
key
, returns
nullptr
.
The description can be one sentence to several paragraphs in length. Paragraphs are delimited with a double newline. Descriptions can be translated and the value returned from this function is is the current locale.
This function is slow. The summary and description information for the schemas is not stored in the compiled schema database so this function has to parse all of the source XML files in the schema directory.
- Returns
-
The description for
key
, or
nullptr
.
Glib::ustring Gio::SettingsSchemaKey::get_name | ( | ) | const |
Glib::ustring Gio::SettingsSchemaKey::get_summary | ( | ) | const |
Gets the summary for key .
If no summary has been provided in the schema for
key
, returns
nullptr
.
The summary is a short description of the purpose of the key; usually one short sentence. Summaries can be translated and the value returned from this function is is the current locale.
This function is slow. The summary and description information for the schemas is not stored in the compiled schema database so this function has to parse all of the source XML files in the schema directory.
- Returns
-
The summary for
key
, or
nullptr
.
GSettingsSchemaKey* Gio::SettingsSchemaKey::gobj | ( | ) |
Provides access to the underlying C instance.
const GSettingsSchemaKey* Gio::SettingsSchemaKey::gobj | ( | ) | const |
Provides access to the underlying C instance.
GSettingsSchemaKey* Gio::SettingsSchemaKey::gobj_copy | ( | ) | const |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
|
protected |
|
delete |
void Gio::SettingsSchemaKey::reference | ( | ) | const |
Increment the reference count for this object.
You should never need to do this manually - use the object via a RefPtr instead.
void Gio::SettingsSchemaKey::unreference | ( | ) | const |
Decrement the reference count for this object.
You should never need to do this manually - use the object via a RefPtr instead.
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.