guit  0.1
 All Classes Functions Variables Typedefs Enumerations Friends
Public Types | Public Member Functions | List of all members
guit::GChoice Class Reference

Enforces exclusive selection in a Box. More...

Inheritance diagram for guit::GChoice:
guit::GInt

Public Types

using Specif = int32_t
 Specificity of Properties.
 

Public Member Functions

GChoiceclone (bool copy_value) const override
 Clones the prop (when applicable). More...
 
auto operator~ ()
 Future value in an Active Expression (see GExpr).
 
GIntoperator<<= (GNumExpr &)
 Binds this prop to an active expression (see GExpr).
 
GIntsetRange (int min, int max)
 Specifies range.
 
GIntsetCycles (bool)
 Specifies whether the int cycles between min() and max() If cycles is true, operator++ sets the value to min() if it becomes >= to max() (same thing the other way with operator–). More...
 
GVarProptoVarProp () override
 Type conversions.
 
bool isMutable () const override
 Returns true if the prop is mutable. More...
 
void setImmutable () override
 Makes the prop immutable. More...
 
void blink (GString const &msg="", GTime duration=500)
 Blinks gadget parents of the prop. More...
 
void update ()
 updates gadget parents of the prop.
 
void perform (std::function< void(Gadget &)> fun)
 performs this function on gadget parents.
 
GPropList const & props () const
 Returns callbacks and bound props.
 
virtual void removeNotifiers (void *object) override
 [Implementation] Notifies this object that it must no longer refer obj.
 
virtual void removeAll ()
 Removes callbacks and notifiers.
 
virtual bool isEquivalent (GProp const &other) const
 Returns true if these props are equivalent. More...
 
virtual bool onAdd (Gadget *)
 Called when the property is added to an object. More...
 
virtual void onRemove (Gadget *)
 Called when the property is removed from an object. More...
 
virtual void error (GString const &funname, GString const &message) const
 Prints an error message. More...
 
void operator delete (void *)
 delete does nothing, see GObject class.
 
void forgetSmartPointers ()
 Forgets all smart pointers pointing this object. More...
 
unsigned int useCount () const
 Returns the numbers of smart pointers referencing the object.
 
 GChoice ()
 Constructor. More...
 
int chosenIndex () const
 Returns the selected (ie checked) item or its index. More...
 
virtual void choose (int index)
 Changes the selected (ie checked) item. More...
 
GChoiceoperator++ ()
 Selects (ie checks) the next or previous checkable item relatively to the current selection.
 
GChoiceoperator+= (int value)
 Selects (ie checks) a checkable item relatively to the current selection.
 
T const & value () const
 Returns the value.
 
bool boolValue () const override
 Returns the value converted to a different type.
 
min () const
 Returns the range (see setRange()).
 
bool read (GString const &filename)
 Reads the value of the prop from a file or a stream.
 
void unbind (GVarProp &sender)
 Unbinds this prop. More...
 
GString typeName () const override
 Returns the name and role of the prop's type.
 
GProptoProp () override
 Class conversions.
 
bool write (GString const &filename) const
 Writes the value of the prop on a file or a stream.
 
template<class Subclass >
Subclass * to ()
 Class conversions.
 
void ignoreSmartPointers ()
 Checks/sets whether this object can be auto-deleted by smart pointers. More...
 
static T lowest ()
 Returns the lowest/highest possible values.
 

Detailed Description

Enforces exclusive selection in a Box.

When adedd to a box, this prop enforces exclusive selection on the checkable children of the Box. It also makes its item/buttons children checkable even if not by default. Any gagdget can be make checkable by calling its setCheckable() method.

Note
GChoiceBox and subclasses rely on GChoice.

Constructor & Destructor Documentation

guit::GChoice::GChoice ( )

Constructor.

index is the index of the ckeched child. This is the position in the child list taking into account only checkable chidren. -1 means no child selected, it's the default value (no arg constr.). When provided, min and max are the mininum and maximun values (should be postive).

Member Function Documentation

GChoice * guit::GChoice::clone ( bool  copy_value) const
overridevirtual

Clones the prop (when applicable).

Mutable props (i.e. deriving from GVarProp) can be cloned, otherwise this method returns null. The value is copied if copy_value is used, the default value is used otherwise.

Reimplemented from guit::GProp.

int guit::GChoice::chosenIndex ( ) const
inline

Returns the selected (ie checked) item or its index.

See GChoiceBox::chosenItem() and GChoiceBox::chosenIndex() for explanation.

virtual void guit::GChoice::choose ( int  index)
inlinevirtual

Changes the selected (ie checked) item.

See GChoiceBox::choose() for explanation.

GInt & guit::GInt::setCycles ( bool  cycles)
inherited

Specifies whether the int cycles between min() and max() If cycles is true, operator++ sets the value to min() if it becomes >= to max() (same thing the other way with operator–).

bool guit::GVarProp::isMutable ( ) const
inlineoverridevirtualinherited

Returns true if the prop is mutable.

Returns true only if the prop derives from GVarProp and setImmutable() was not called. Props with another type than GVarProp are always immutable.

Reimplemented from guit::GProp.

void guit::GVarProp::setImmutable ( )
inlineoverridevirtualinherited

Makes the prop immutable.

Affects only GVarProp props (other props are always immutable). A prop cannot be made mutable again after this method has been called.

Reimplemented from guit::GProp.

void guit::GVarProp::unbind ( GVarProp sender)
inherited

Unbinds this prop.

  • the first version unbinds another prop (note that it doesn't unbind Prop fields).
  • the second version unbinds bindings according to its bindtag argument:

    if bindtag is >= 0, unbinds bindings performed with the same bindtag (default by 0, see bind())

if bindtag is < 0, unbinds all bindings with a value >= bindtag

Importantly, these methods unbinds props both ways if the binding was done both ways (e.g. by using sync())

void guit::GVarProp::blink ( GString const &  msg = "",
GTime  duration = 500 
)
inherited

Blinks gadget parents of the prop.

Shows a warning if msg is not empty.

bool guit::GProp::isEquivalent ( GProp const &  other) const
virtualinherited

Returns true if these props are equivalent.

Adding a prop to a gadget replaces the equivalent prop it contains (if it contains any). In all other cases, the prop is added to the gadget proplist. NOTE: props with a negative role are never equivalent!

Reimplemented in guit::GExpr, guit::GCond, guit::GState, and guit::GAnim.

bool guit::GProp::onAdd ( Gadget g)
virtualinherited

Called when the property is added to an object.

note: must call addModes().

Reimplemented in guit::GTextData, guit::GTip, guit::GCond, guit::GDragPos, guit::GDragSize, guit::GPos, guit::GText, guit::GSize, guit::GFlex, guit::GFlow, guit::GItems, and guit::GValue.

void guit::GProp::onRemove ( Gadget g)
virtualinherited

Called when the property is removed from an object.

note: must call removeModes().

Reimplemented in guit::GTextData, guit::GTip, guit::GCond, guit::GDragPos, guit::GDragSize, guit::GPos, guit::GText, guit::GSize, guit::GFlex, and guit::GHotkey.

void guit::GObject::error ( GString const &  funname,
GString const &  message 
) const
virtualinherited

Prints an error message.

See Also
GApp::onError() to change error management.
void guit::GObject::ignoreSmartPointers ( )
inlineinherited

Checks/sets whether this object can be auto-deleted by smart pointers.

ignoreSmartPointers() has a permanent effect, contrary to forgetSmartPointers(). Objects not created by calling new are never auto-deleted by smart pointers.

void guit::GObject::forgetSmartPointers ( )
inlineinherited

Forgets all smart pointers pointing this object.

The smart pointers that are currently pointing to the object won't auto-delete it. forgetSmartPointers() has a temporary effect, contrary to ignoreSmartPointers().


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