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

An edit constraint allows to suggest values for a variable. More...

#include <aqt/cassowary/Edit.hpp>

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

Public Member Functions

 Edit (QQuickItem *pParent=0)
 
Q_SIGNAL void suggestedChanged (double suggested)
 
Q_INVOKABLE void suggest (double value)
 Instantanously suggest a new value for the target variable. More...
 
- Public Member Functions inherited from aqt::cassowary::Targeted
 Targeted (QQuickItem *pParent=nullptr, Strength::Types strength=Strength::Required, double weight=1.0)
 
Q_SIGNAL void targetChanged (aqt::cassowary::Variable *target)
 
VariableactualTarget ()
 
Q_SIGNAL void actualTargetChanged (aqt::cassowary::Variable *target)
 
- Public Member Functions inherited from aqt::cassowary::ConstraintBase
 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

void addIn (Context &solver) override
 
void removeIn (Context &solver) override
 
- Protected Member Functions inherited from aqt::cassowary::ConstraintBase
bool when () const
 
const rhea::constraint & get () const
 
void set (std::shared_ptr< rhea::abstract_constraint > constraint)
 
- 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

double suggested
 Number containing the current suggestion for what the user wants the value of the target variable to be.
 
- Properties inherited from aqt::cassowary::Targeted
aqt::cassowary::Variable target
 Explicitly set target variable. More...
 
aqt::cassowary::Variable actualTarget
 Returns the effective target. More...
 
- Properties inherited from aqt::cassowary::ConstraintBase
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

An edit constraint allows to suggest values for a variable.

It can be used to represent the user's wish.

Example
Solver {
Variable {
id: vX
Stay {}
Edit {
suggested: mouseArea.mouseX
when: mouseArea.pressed
}
}
}
MouseArea { id: mouseArea }
Import in QML
import Aqt.Cassowary 1.0
Since
1.0
See also
Stay
Targeted

Member Function Documentation

Q_INVOKABLE void aqt::cassowary::Edit::suggest ( double  value)

Instantanously suggest a new value for the target variable.

This does not change the suggested property.


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