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

Tool Tip. More...

Inheritance diagram for guit::GTip:
guit::GText guit::GVarProp_< GString > guit::GVarProp guit::GProp guit::GObject

Public Types

using Specif = int32_t
 Specificity of Properties.
 

Public Member Functions

GTipclone (bool copy_value) const override
 Clones the prop (when applicable). More...
 
GString stringValue () const override
 Returns the value of the prop as a string. More...
 
float floatValue () const override
 Returns the value of the prop as a float. More...
 
auto operator~ ()
 Future value in an Active Expression (see GExpr).
 
GTextoperator<<= (GExpr &)
 Binds this prop to an Active Expression.
 
void set (GString const &str) override
 Changes value.
 
void set (GProp const &) override
 Changes value. More...
 
virtual void set (GStringconst &value, bool callalways)
 Changes the value. More...
 
char operator[] (size_t pos) const
 returns the char at this position. More...
 
GDim textSize (GFont &, bool richtext, bool multilines, GTextAttributes const *=nullptr) const
 returns the size of the text.
 
GVarProptoVarProp () override
 Type conversions.
 
bool isMutable () const override
 Returns true if the prop is mutable. More...
 
void setImmutable () override
 Makes the prop immutable. More...
 
virtual void blend (GProp const &value1, GProp const &value2, float mix)
 Changes value by blending the value of two props. 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 boolValue () const
 Returns the value as a bool. More...
 
virtual bool isEquivalent (GProp const &other) const
 Returns true if these props are equivalent. 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.
 
bool read (GString const &filename)
 Reads the value of the prop from a file or a stream.
 
ssize_t posToIndex (ssize_t charpos, bool richtext) const
 converts position of character (UTF8 code point) to index (byte position) and vice-versa. More...
 
ssize_t nextIndex (ssize_t bytepos, bool richtext) const
 returns index (byte position) of next or previous character. More...
 
GStringconst & value () const
 Returns the value.
 
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...
 

Protected Member Functions

bool onAdd (Gadget *) override
 Called when the property is added to an object. More...
 
void onRemove (Gadget *) override
 Called when the property is removed from an object. More...
 

Detailed Description

Tool Tip.

Member Function Documentation

GTip * guit::GTip::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::GText.

bool guit::GTip::onAdd ( Gadget g)
overrideprotectedvirtual

Called when the property is added to an object.

note: must call addModes().

Reimplemented from guit::GText.

void guit::GTip::onRemove ( Gadget g)
overrideprotectedvirtual

Called when the property is removed from an object.

note: must call removeModes().

Reimplemented from guit::GText.

GString guit::GText::stringValue ( ) const
inlineoverridevirtualinherited

Returns the value of the prop as a string.

Returns "" if the prop has no value of its value cannot be converted to a string.

Reimplemented from guit::GProp.

float guit::GText::floatValue ( ) const
overridevirtualinherited

Returns the value of the prop as a float.

Returns 0.f if the prop has no value of its value cannot be converted to a float.

Reimplemented from guit::GProp.

void guit::GText::set ( GProp const &  value)
overridevirtualinherited

Changes value.

Does nothing if the type of from is not convertible to the type of this prop.

See Also
set() and operator=() methods in subclasses

Implements guit::GVarProp.

virtual void guit::GVarProp_< GString >::set ( GString const &  value,
bool  callalways 
)
inlinevirtualinherited

Changes the value.

Callbacks are fired and parent gadgets updated if:

  • the value is different from the value that was previously set (using set() or operator=)
  • callalways is true, in which case they are always fired Does nothing and produces an warning if the prop is immutable (see setImmutable())
char guit::GText::operator[] ( size_t  pos) const
inherited

returns the char at this position.

checks bounds: returns 0 if pos is out of bounds.

ssize_t guit::GText::posToIndex ( ssize_t  charpos,
bool  richtext 
) const
inherited

converts position of character (UTF8 code point) to index (byte position) and vice-versa.

  • each UTF8 character can occupy 1 to 4 bytes.
  • returns position of last byte/character if first argument is < 0.
ssize_t guit::GText::nextIndex ( ssize_t  bytepos,
bool  richtext 
) const
inherited

returns index (byte position) of next or previous character.

  • each UTF8 character can occupy 1 to 4 bytes.
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::blend ( GProp const &  value1,
GProp const &  value2,
float  mix 
)
virtualinherited

Changes value by blending the value of two props.

Does nothing if the type of from1 or from2 is not convertible to the type of this prop.

Reimplemented in guit::GColor, guit::GPos, and guit::GSize.

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.

virtual bool guit::GProp::boolValue ( ) const
inlinevirtualinherited

Returns the value as a bool.

Returns false if the prop has no value of its value cannot be converted to a bool.

Reimplemented in guit::GNumExpr, guit::GTextExpr, guit::GBoolExpr, guit::GExpr, and guit::GBool.

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.

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: