glibmm: Glib::PropertyBase Class Reference

glibmm 2.88.1

Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Glib::PropertyBase Class Reference

This is the base class for Glib::Object properties. More...

`#include <glibmm/property.h>`

Inheritance diagram for Glib::PropertyBase:
[legend]

## Public Member Functions
| PropertyBase (const PropertyBase &)=delete
PropertyBase & | operator= (const PropertyBase &)=delete
Glib::ustring | get_name () const
| Returns the name of the property.
Glib::ustring | get_nick () const
| Returns the nickname of the property.
Glib::ustring | get_blurb () const
| Returns the short description of the property.
void | notify ()
| Notifies the object containing the property that the property has changed.

## Protected Member Functions
| PropertyBase (Glib::Object & object, GType value_type)
| This constructs a property of type value_type for the object.
| ~PropertyBase () noexcept
bool | lookup_property (const Glib::ustring & name)
| Checks if the property has already been installed.
void | install_property (GParamSpec * param_spec)
| Installs the property specified by the given param_spec.
const char * | get_name_internal () const
| Returns the name of the property.

## Protected Attributes
Glib::Object * | object_
Glib::ValueBase | value_
GParamSpec * | param_spec_

## Detailed Description

This is the base class for Glib::Object properties.

This class manages the generic parts of the object properties. Derived (templated) classes handle the specific value types.

## Constructor & Destructor Documentation

## ◆ PropertyBase() [1/2]

Glib::PropertyBase::PropertyBase | ( | const PropertyBase & |  | ) |
| delete

## ◆ PropertyBase() [2/2]

Glib::PropertyBase::PropertyBase | ( | Glib::Object & | object,
|  | GType | value_type )
| protected

This constructs a property of type value_type for the object.

The property is not registered in the GObject object system until install_property() has been called. Derived classes do this in their constructors.

The properties are usually installed during the initialization of the first instance of an object.

## ◆ ~PropertyBase()

Glib::PropertyBase::~PropertyBase | ( |  | ) |
| protectednoexcept

## Member Function Documentation

## ◆ get_blurb()

Glib::ustring Glib::PropertyBase::get_blurb | ( |  | ) | const

Returns the short description of the property.

## ◆ get_name()

Glib::ustring Glib::PropertyBase::get_name | ( |  | ) | const

Returns the name of the property.

## ◆ get_name_internal()

const char * Glib::PropertyBase::get_name_internal | ( |  | ) | const
| protected

Returns the name of the property.

## ◆ get_nick()

Glib::ustring Glib::PropertyBase::get_nick | ( |  | ) | const

Returns the nickname of the property.

## ◆ install_property()

void Glib::PropertyBase::install_property | ( | GParamSpec * | param_spec | ) |
| protected

Installs the property specified by the given param_spec.

## ◆ lookup_property()

bool Glib::PropertyBase::lookup_property | ( | const Glib::ustring & | name | ) |
| protected

Checks if the property has already been installed.

## ◆ notify()

void Glib::PropertyBase::notify | ( |  | ) |

Notifies the object containing the property that the property has changed.

This emits the "notify" signal, passing the property name.

## ◆ operator=()

PropertyBase & Glib::PropertyBase::operator= | ( | const PropertyBase & |  | ) |
| delete

## Member Data Documentation

## ◆ object_

Glib::Object* Glib::PropertyBase::object_
| protected

## ◆ param_spec_

GParamSpec* Glib::PropertyBase::param_spec_
| protected

## ◆ value_

Glib::ValueBase Glib::PropertyBase::value_
| protected