Input channel. More...
Public Types | |
using | Specif = int32_t |
Specificity of Properties. | |
Public Member Functions | |
GCursor * | clone (bool) const override |
Clones the prop (when applicable). More... | |
unsigned int | channel () const |
returns the channel of this cursor. | |
GCursor & | operator<< (GFunction const &fun) |
Adds a callback that is fired when the mouse value is changed. | |
void | show (bool state) |
Shows/hides this cursor. | |
void | freeze (bool state) |
Freezes this cursor. More... | |
void | setColor (GColor &) |
Changes the color of the cursor. | |
GColor & | color () const |
Returns the color of the cursor. | |
void | setShape (Shape) |
Changes the shape of the cursor. More... | |
Shape | shape () const |
Returns the shape of the cursor. | |
void | displayAsNative (bool) |
Displays this cursor as a native cursor. More... | |
void | startDrag (Gadget &from, std::function< void(GCursor &)> const &onDrop, Shape=Hand) |
Starts a Drag & Drop action controlled by this cursor. More... | |
bool | isDragging () const |
Returns true if a Drag & Drop is being performed. | |
Gadget * | source () |
Returns the gadget where the Drag & Drop started from (if any). | |
GWindow * | sourceWindow () |
Returns the window where the Drag & Drop started from (if any). | |
Gadget * | target () |
Returns the gadget where the Drag & Drop ended (if any). | |
GWindow * | targetWindow () |
Returns the window where the Drag & Drop ended (if any). | |
GPoint const & | targetPos () |
Returns the position in the window where the Drag & Drop ended. | |
virtual bool | isMutable () const |
Returns true if the prop is mutable. More... | |
virtual void | setImmutable () |
Makes the prop immutable. More... | |
virtual GString | stringValue () const |
Returns the value of the prop as a string. More... | |
virtual float | floatValue () const |
Returns the value of the prop as a float. More... | |
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 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. | |
virtual void | removeNotifiers (void *obj) |
[Implementation] Notifies this object that it must no longer refer obj. | |
void | move (GPoint const &pos) |
Moves the cursor on the screen (screen coordinates). | |
GPoint const & | pos () const |
Returns the position of the cursor on the screen. | |
GPoint | wpos () const |
Returns the position of the cursor relative to the current window. More... | |
GString | typeName () const override |
Returns the name and role of the prop's type. | |
GProp * | toProp () override |
Class conversions. | |
bool | write (GString const &filename) const |
Writes the value of the prop on a file or a stream. | |
virtual class GVarProp * | toVarProp () |
Type conversions. | |
template<class Subclass > | |
Subclass * | to () |
Class conversions. | |
void | ignoreSmartPointers () |
Checks/sets whether this object can be auto-deleted by smart pointers. More... | |
Static Public Member Functions | |
static GDim | screenSize () |
Returns the size of the main screen. | |
static GCursor * | cursor (unsigned int channel=0) |
Returns the cursor corresponding to this input channel if it exists, null otherwise. More... | |
static GCursor & | obtainCursor (unsigned int channel=0) |
Returns the cursor corresponding to this channel, creates it if needed. More... | |
static int | cursorCount () |
Returns the number of cursors that currently exist. More... | |
using | GType = GPropType |
Returns prop's meta-class. More... | |
Input channel.
|
inherited |
Returns prop's meta-class.
Both functions return the prop's type, but Type() is a static method and type() a virtual method.
|
inlineoverridevirtualinherited |
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.
|
staticinherited |
Returns the cursor corresponding to this input channel if it exists, null otherwise.
|
staticinherited |
Returns the cursor corresponding to this channel, creates it if needed.
|
staticinherited |
Returns the number of cursors that currently exist.
Always >= 1 because this count includes the system cursor.
|
inherited |
Returns the position of the cursor relative to the current window.
Return {0,0} if no current window
|
inherited |
Freezes this cursor.
The cursors won't move if state is true. However if will still receive events.
|
inherited |
Changes the shape of the cursor.
Works only if this cursor display a native cursor (typically, cursor(0)).
|
inherited |
Displays this cursor as a native cursor.
This cursor will be displayed as a native cursor, even if it's not the system cursor. This feature allows moving the native cursor in a customized way that don't depend on the native event flow, e.g. to change the mouse gain dynamically or to process input from multiple touchpads differently. The system cursor (cursor(0)) should then typically be frozen, meaning it will still receive events but won't move the cursor on the screen. This method has no effect of the system cursor (cursor(0)).
|
inherited |
Starts a Drag & Drop action controlled by this cursor.
onDrop is called when the drag-and-drop operation ends.
|
inlinevirtualinherited |
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 in guit::GVarProp.
|
inlinevirtualinherited |
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 in guit::GVarProp.
|
inlinevirtualinherited |
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 in guit::GNumExpr, guit::GTextExpr, guit::GBoolExpr, guit::GOtherwise, guit::GGuard, guit::GVarProp_< T >, guit::GVarProp_< GMarginValue >, guit::GVarProp_< GFlexValue >, guit::GVarProp_< GSizeValue >, guit::GVarProp_< GIconValue >, guit::GVarProp_< GFontValue >, guit::GVarProp_< GGapValue >, guit::GVarProp_< GPosValue >, guit::GVarProp_< GRgba >, guit::GVarProp_< GBorderValue >, guit::GVarProp_< bool >, guit::GVarProp_< GString >, guit::GVarProp_< GFormatValue >, guit::GVarProp_< GAlignValue >, guit::GVarProp_< GFlowValue >, guit::GCond, guit::GExpr, guit::GState, guit::GAnim, and guit::GText.
|
inlinevirtualinherited |
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 in guit::GNumExpr, guit::GTextExpr, guit::GBoolExpr, guit::GExpr, guit::GState, guit::GText, and guit::GBool.
|
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.
|
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.
|
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.
|
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.
|
virtualinherited |
Prints an error message.
|
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.
|
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().