Aqt.Cassowary
Public Member Functions | Protected Member Functions | Properties | List of all members
aqt::cassowary::ConstraintBase Class Reference

Common abstract base of all constraint types, providing common properties and behavior. More...

#include <aqt/cassowary/ConstraintBase.hpp>

Inheritance diagram for aqt::cassowary::ConstraintBase:
aqt::cassowary::Contextual aqt::cassowary::Constraint aqt::cassowary::Targeted aqt::cassowary::Edit aqt::cassowary::Stay

Public Member Functions

 ConstraintBase (QQuickItem *pParent=nullptr, Strength::Types strength=Strength::Required, double weight=1.0)
 
Q_SIGNAL void strengthChanged (aqt::cassowary::Strength::Types strength)
 
Q_SIGNAL void weightChanged (double weight)
 
Q_SIGNAL void whenChanged (bool when)
 
- Public Member Functions inherited from aqt::cassowary::Contextual
 Contextual (QQuickItem *pParent=nullptr)
 
std::shared_ptr< Contextcontext ()
 
std::shared_ptr< const Contextcontext () const
 
Q_SIGNAL void contextChanged ()
 
Q_SIGNAL void extendChanged (aqt::cassowary::Contextual *extend)
 
Q_INVOKABLE void commit ()
 Applies all the changes associated to the context used by this contextual. More...
 
Q_INVOKABLE void defer (QJSValue cb)
 Executes the callback cb at the end of the next phase of updates in the solver, but before the changes are propagated to the bindings.
 
void defer (Context::Callback cb)
 
void defer_ (Context::Callback cb)
 
template<typename... Args>
void log (Args &&...args)
 Used to log a debug trace, that may be visible when the current context's debug property is set. More...
 

Protected Member Functions

bool when () const
 
const rhea::constraint & get () const
 
void set (std::shared_ptr< rhea::abstract_constraint > constraint)
 
void addIn (Context &ctx) override
 
void removeIn (Context &ctx) override
 
- Protected Member Functions inherited from aqt::cassowary::Contextual
void add ()
 
void remove ()
 
template<typename Fn >
void update (Fn &&cb)
 
template<typename Fn >
Context::Callback guarded (Fn fn)
 
void updateContext ()
 
Contextualprovider ()
 
virtual std::shared_ptr< Contextprovided ()
 

Properties

aqt::cassowary::Strength::Types strength
 Sets the strength of a constraint. More...
 
double weight
 Sets the weight of a constraint. More...
 
bool when
 The constraint is enabled when this property holds a true value, otherwise it has no effect.
 
- Properties inherited from aqt::cassowary::Contextual
aqt::cassowary::Contextual extend
 If non-null, this contextual will use the same context as used by this contextual.
 

Detailed Description

Common abstract base of all constraint types, providing common properties and behavior.

See also
Constraint
Edit
Stay
Contextual

Property Documentation

aqt::cassowary::Strength::Types aqt::cassowary::ConstraintBase::strength

Sets the strength of a constraint.

See also
Strength
double aqt::cassowary::ConstraintBase::weight

Sets the weight of a constraint.

The weight disambiguates the priority of constraints with the same strenght. Constraints with higher weight have higher priority.


The documentation for this class was generated from the following file: