|
gtkmm 4.14.0
|
The description of a constraint. More...
#include <gtkmm/constraint.h>

Classes | |
| class | Strength_Wrapper |
| Wrapper for enum Strength. More... | |
Public Types | |
| enum class | Attribute { Attribute::NONE , Attribute::LEFT , Attribute::RIGHT , Attribute::TOP , Attribute::BOTTOM , Attribute::START , Attribute::END , Attribute::WIDTH , Attribute::HEIGHT , Attribute::CENTER_X , Attribute::CENTER_Y , Attribute::BASELINE } |
| The widget attributes that can be used when creating a Gtk::Constraint. More... | |
| enum class | Relation { Relation::LE = -1 , Relation::EQ , Relation::GE } |
| The relation between two terms of a constraint. More... | |
| using | Strength = Strength_Wrapper::Strength |
| Strength enumerators are scoped by the wrapper class and can be implicitly converted to int. More... | |
Public Types inherited from Glib::Object | |
| typedef void(*)(gpointer data | DestroyNotify) |
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 | |
| Constraint (Constraint && src) noexcept | |
| Constraint & | operator= (Constraint && src) noexcept |
| ~Constraint () noexcept override | |
| GtkConstraint * | gobj () |
| Provides access to the underlying C GObject. More... | |
| const GtkConstraint * | gobj () const |
| Provides access to the underlying C GObject. More... | |
| GtkConstraint * | gobj_copy () |
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
| Glib::RefPtr< ConstraintTarget > | get_target () |
| Retrieves the Gtk::ConstraintTarget used as the target for the constraint. More... | |
| Glib::RefPtr< const ConstraintTarget > | get_target () const |
| Retrieves the Gtk::ConstraintTarget used as the target for the constraint. More... | |
| Attribute | get_target_attribute () const |
| Retrieves the attribute of the target to be set by the constraint. More... | |
| Glib::RefPtr< ConstraintTarget > | get_source () |
| Retrieves the Gtk::ConstraintTarget used as the source for the constraint. More... | |
| Glib::RefPtr< const ConstraintTarget > | get_source () const |
| Retrieves the Gtk::ConstraintTarget used as the source for the constraint. More... | |
| Attribute | get_source_attribute () const |
| Retrieves the attribute of the source to be read by the constraint. More... | |
| Relation | get_relation () const |
| The order relation between the terms of the constraint. More... | |
| double | get_multiplier () const |
| Retrieves the multiplication factor applied to the source attribute's value. More... | |
| double | get_constant () const |
| Retrieves the constant factor added to the source attributes' value. More... | |
| int | get_strength () const |
| Retrieves the strength of the constraint. More... | |
| bool | is_required () const |
| Checks whether the constraint is a required relation for solving the constraint layout. More... | |
| bool | is_attached () const |
| Checks whether the constraint is attached to a Gtk::ConstraintLayout, and it is contributing to the layout. More... | |
| bool | is_constant () const |
| Checks whether the constraint describes a relation between an attribute on the property_target() and a constant value. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::RefPtr< ConstraintTarget > > | property_target () const |
| The target of the constraint. More... | |
| Glib::PropertyProxy_ReadOnly< Attribute > | property_target_attribute () const |
| The attribute of the property_target() set by the constraint. More... | |
| Glib::PropertyProxy_ReadOnly< Relation > | property_relation () const |
| The order relation between the terms of the constraint. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::RefPtr< ConstraintTarget > > | property_source () const |
| The source of the constraint. More... | |
| Glib::PropertyProxy_ReadOnly< Attribute > | property_source_attribute () const |
| The attribute of the property_source() read by the constraint. More... | |
| Glib::PropertyProxy_ReadOnly< double > | property_multiplier () const |
| The multiplication factor to be applied to the property_source_attribute(). More... | |
| Glib::PropertyProxy_ReadOnly< double > | property_constant () const |
| The constant value to be added to the property_source_attribute(). More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_strength () const |
| The strength of the constraint. 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_with_c_callback (const Quark &key, void *data, GDestroyNotify notify) |
| void | set_data (const Quark &key, void *data, DestroyNotify notify) |
| void | remove_data (const QueryQuark &quark) |
| void * | steal_data (const QueryQuark &quark) |
| Glib::RefPtr< Glib::Object > | wrap (GObject *object, bool take_copy=false) |
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) |
| void | get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const |
| void | set_property (const Glib::ustring &property_name, const PropertyType &value) |
| void | get_property (const Glib::ustring &property_name, PropertyType &value) const |
| PropertyType | get_property (const Glib::ustring &property_name) const |
| sigc::connection | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot) |
| sigc::connection | connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot) |
| void | freeze_notify () |
| void | thaw_notify () |
| virtual void | reference () const |
| virtual void | unreference () const |
| GObject * | gobj () |
| const GObject * | gobj () const |
| GObject * | gobj_copy () const |
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 |
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< Constraint > | create (const Glib::RefPtr< ConstraintTarget > & target, Attribute target_attribute, Relation relation, const Glib::RefPtr< ConstraintTarget > & source, Attribute source_attribute, double multiplier, double constant, int strength) |
| Creates a new Gtk::Constraint representing a relation between a layout attribute on a source and a layout attribute on a target. More... | |
| static Glib::RefPtr< Constraint > | create (const Glib::RefPtr< ConstraintTarget > & target, Attribute target_attribute, Relation relation, double constant, int strength) |
| Creates a new Gtk::Constraint representing a relation between a layout attribute on a target and a constant value. More... | |
Protected Member Functions | |
| Constraint (const Glib::RefPtr< ConstraintTarget > & target, Attribute target_attribute, Relation relation, const Glib::RefPtr< ConstraintTarget > & source, Attribute source_attribute, double multiplier, double constant, int strength) | |
| Constraint (const Glib::RefPtr< ConstraintTarget > & target, Attribute target_attribute, Relation relation, double constant, int strength) | |
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 () | |
| ObjectBase (const char *custom_type_name) | |
| ObjectBase (const std::type_info &custom_type_info) | |
| 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) |
Related Functions | |
(Note that these are not member functions.) | |
| Glib::RefPtr< Gtk::Constraint > | wrap (GtkConstraint * object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
The description of a constraint.
Gtk::Constraint describes a constraint between an attribute on a widget and another attribute on another widget, expressed as a linear equation like:
target.attr1 = source.attr2 × multiplier + constant
Each Constraint is part of a system that will be solved by a Gtk::ConstraintLayout in order to allocate and position each child widget.
A Constraint is immutable once it's created.
|
noexcept |
|
overridenoexcept |
|
explicitprotected |
|
explicitprotected |
|
static |
Creates a new Gtk::Constraint representing a relation between a layout attribute on a source and a layout attribute on a target.
| target | A Gtk::ConstraintTarget or an empty Glib::RefPtr. |
| target_attribute | The attribute of target to be set. |
| relation | The relation equivalence between target_attribute and source_attribute. |
| source | A Gtk::ConstraintTarget or an empty Glib::RefPtr. |
| source_attribute | The attribute of source to be read. |
| multiplier | A multiplication factor to be applied to source_attribute. |
| constant | A constant to be added to source_attribute. |
| strength | The strength of the constraint. |
|
static |
Creates a new Gtk::Constraint representing a relation between a layout attribute on a target and a constant value.
| target | A Gtk::ConstraintTarget or an empty Glib::RefPtr. |
| target_attribute | The attribute of target to be set. |
| relation | The relation equivalence between target_attribute and constant. |
| constant | A constant to be set on target_attribute. |
| strength | The strength of the constraint. |
| double Gtk::Constraint::get_constant | ( | ) | const |
Retrieves the constant factor added to the source attributes' value.
| double Gtk::Constraint::get_multiplier | ( | ) | const |
Retrieves the multiplication factor applied to the source attribute's value.
| Relation Gtk::Constraint::get_relation | ( | ) | const |
The order relation between the terms of the constraint.
| Glib::RefPtr< ConstraintTarget > Gtk::Constraint::get_source | ( | ) |
Retrieves the Gtk::ConstraintTarget used as the source for the constraint.
If the source is set to nullptr at creation, the constraint will use the widget using the Gtk::ConstraintLayout as the source.
| Glib::RefPtr< const ConstraintTarget > Gtk::Constraint::get_source | ( | ) | const |
Retrieves the Gtk::ConstraintTarget used as the source for the constraint.
If the source is set to nullptr at creation, the constraint will use the widget using the Gtk::ConstraintLayout as the source.
| Attribute Gtk::Constraint::get_source_attribute | ( | ) | const |
Retrieves the attribute of the source to be read by the constraint.
| int Gtk::Constraint::get_strength | ( | ) | const |
Retrieves the strength of the constraint.
| Glib::RefPtr< ConstraintTarget > Gtk::Constraint::get_target | ( | ) |
Retrieves the Gtk::ConstraintTarget used as the target for the constraint.
If the targe is set to nullptr at creation, the constraint will use the widget using the Gtk::ConstraintLayout as the target.
Gtk::ConstraintTarget. | Glib::RefPtr< const ConstraintTarget > Gtk::Constraint::get_target | ( | ) | const |
Retrieves the Gtk::ConstraintTarget used as the target for the constraint.
If the targe is set to nullptr at creation, the constraint will use the widget using the Gtk::ConstraintLayout as the target.
Gtk::ConstraintTarget. | Attribute Gtk::Constraint::get_target_attribute | ( | ) | const |
Retrieves the attribute of the target to be set by the constraint.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
| GtkConstraint * Gtk::Constraint::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
| bool Gtk::Constraint::is_attached | ( | ) | const |
Checks whether the constraint is attached to a Gtk::ConstraintLayout, and it is contributing to the layout.
true if the constraint is attached. | bool Gtk::Constraint::is_constant | ( | ) | const |
Checks whether the constraint describes a relation between an attribute on the property_target() and a constant value.
true if the constraint is a constant relation. | bool Gtk::Constraint::is_required | ( | ) | const |
Checks whether the constraint is a required relation for solving the constraint layout.
true if the constraint is required.
|
noexcept |
| Glib::PropertyProxy_ReadOnly< double > Gtk::Constraint::property_constant | ( | ) | const |
The constant value to be added to the property_source_attribute().
Default value: 0
| Glib::PropertyProxy_ReadOnly< double > Gtk::Constraint::property_multiplier | ( | ) | const |
The multiplication factor to be applied to the property_source_attribute().
Default value: 1
| Glib::PropertyProxy_ReadOnly< Relation > Gtk::Constraint::property_relation | ( | ) | const |
The order relation between the terms of the constraint.
Default value: Gtk::Constraint::Relation::EQ
| Glib::PropertyProxy_ReadOnly< Glib::RefPtr< ConstraintTarget > > Gtk::Constraint::property_source | ( | ) | const |
The source of the constraint.
The constraint will set the property_target_attribute() property of the target using the property_source_attribute() property of the source.
| Glib::PropertyProxy_ReadOnly< Attribute > Gtk::Constraint::property_source_attribute | ( | ) | const |
The attribute of the property_source() read by the constraint.
Default value: Gtk::Constraint::Attribute::NONE
| Glib::PropertyProxy_ReadOnly< int > Gtk::Constraint::property_strength | ( | ) | const |
The strength of the constraint.
The strength can be expressed either using one of the symbolic values of the Gtk::ConstraintStrength enumeration, or any positive integer value.
Default value: 1001001000
| Glib::PropertyProxy_ReadOnly< Glib::RefPtr< ConstraintTarget > > Gtk::Constraint::property_target | ( | ) | const |
The target of the constraint.
The constraint will set the property_target_attribute() property of the target using the property_source_attribute() property of the source widget.
| Glib::PropertyProxy_ReadOnly< Attribute > Gtk::Constraint::property_target_attribute | ( | ) | const |
The attribute of the property_target() set by the constraint.
Default value: Gtk::Constraint::Attribute::NONE
|
related |
A Glib::wrap() method for this object.
| 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. |