Name

UiAction — UiAction is class for UI commands, emited by buttons, menu items and widgets.

Synopsis

class UiAction
  :  : public RefCountedWrappedObjectSernaApi::RefCountedWrappedObject
 {
public:
  // construct/copy/destruct
  UiAction(SernaApiBase * = 0);
  ~UiAction();

  // public member functions

  SString name() const;
  PropertyNode property(const SString &) const;
  PropertyNode properties() const;
  SString get(const SString &) const;
  SString getTranslated(const SString &) const;
  bool getBool(const SString &) const;
  int getInt(const SString &) const;
  double getDouble(const SString &) const;
  void set(const SString &, const SString &) ;
  void setBool(const SString &, bool) ;
  void setInt(const SString &, int) ;
  void setDouble(const SString &, double) ;
  bool isEnabled() const;
  void setEnabled(bool) ;
  bool isToggleable() const;
  bool isToggledOn() const;
  void setToggled(bool) ;
  void dispatch() const;
  void dump() const;
  UiAction firstChild() const;
  UiAction lastChild() const;
  UiAction getChild(int) const;
  int countChildren() const;
  void appendChild(const UiAction &) ;
  void removeAllChildren() ;
  UiAction nextSibling() const;
  UiAction prevSibling() const;
  UiAction parent() const;
  UiAction root() const;
  void remove() ;
  void insertBefore(const UiAction &) ;
  void insertAfter(const UiAction &) ;
  void removeGroup(const UiAction &) ;
  int siblingIndex() const;
  SString getTreelocString(const UiAction & = UiAction()) const;
  UiAction getByTreelocString(const SString &) const;
};

Description

UiAction construct/copy/destruct

  1. UiAction(SernaApiBase * = 0);


  2. ~UiAction();


UiAction public member functions

  1. SString name() const;

    Command name.


  2. PropertyNode property(const SString & prop) const;

    Returns actin property by name.


  3. PropertyNode properties() const;

    Properties of the action.


  4. SString get(const SString & propName) const;

    Accesor to concrete property value.


  5. SString getTranslated(const SString & propName) const;

    Accesor to concrete property value.


  6. bool getBool(const SString & propName) const;

    Returns boolean property value.


  7. int getInt(const SString & propName) const;

    Returns integer property value.


  8. double getDouble(const SString & propName) const;

    Returns double property value.


  9. void set(const SString & propName, const SString & value) ;

    Set property with name and value.


  10. void setBool(const SString & propName, bool value) ;

    Sets boolean property value.


  11. void setInt(const SString & propName, int value) ;

    Sets integer property value.


  12. void setDouble(const SString & propName, double value) ;

    Sets double property value.


  13. bool isEnabled() const;

    Returns enabled state.


  14. void setEnabled(bool ) ;

    Change enabled state.


  15. bool isToggleable() const;

    Returns true if command can be toggled.


  16. bool isToggledOn() const;

    Returns toggled state.


  17. void setToggled(bool ) ;

    Sets toggled state.


  18. void dispatch() const;

    Dispatches the command.


  19. void dump() const;

    Dumps command properties.


  20. UiAction firstChild() const;


  21. UiAction lastChild() const;


  22. UiAction getChild(int n) const;


  23. int countChildren() const;


  24. void appendChild(const UiAction & ) ;


  25. void removeAllChildren() ;


  26. UiAction nextSibling() const;


  27. UiAction prevSibling() const;


  28. UiAction parent() const;


  29. UiAction root() const;


  30. void remove() ;


  31. void insertBefore(const UiAction & ) ;


  32. void insertAfter(const UiAction & ) ;


  33. void removeGroup(const UiAction & ) ;


  34. int siblingIndex() const;


  35. SString getTreelocString(const UiAction & = UiAction()) const;


  36. UiAction getByTreelocString(const SString & ) const;