synthclone  0.3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
synthclone::MenuAction Class Reference

MenuAction objects are triggerable choices in a menu. More...

#include <synthclone/menuaction.h>

Inheritance diagram for synthclone::MenuAction:
Collaboration diagram for synthclone::MenuAction:

Public Slots

void setDescription (const QString &description)
 Sets the description. More...
 
void setEnabled (bool enabled)
 Sets a boolean indicating whether or not this action is able to be triggered. More...
 
void setText (const QString &text)
 Sets the action text. More...
 
void trigger ()
 Triggers the action. More...
 
- Public Slots inherited from synthclone::MenuItem
void setVisible (bool visible)
 Sets the visibility of this item. More...
 

Signals

void descriptionChanged (const QString &description)
 Emitted when the description is changed. More...
 
void enabledChanged (bool enabled)
 Emitted when the 'enabled' flag is changed. More...
 
void textChanged (const QString &text)
 Emitted when the action text is changed. More...
 
void triggered ()
 Emitted when this action is triggered. More...
 
- Signals inherited from synthclone::MenuItem
void visibilityChanged (bool visible)
 Emitted when the visibility of this item is changed. More...
 

Public Member Functions

 MenuAction (QObject *parent=0)
 Constructs an new MenuAction object. More...
 
 MenuAction (const QString &text, QObject *parent=0)
 Constructs a new MenuAction object. More...
 
 MenuAction (const QString &text, const QString &description, QObject *parent=0)
 Constructs a new MenuAction object. More...
 
 ~MenuAction ()
 Destroys the MenuAction object. More...
 
QString getDescription () const
 Gets the action description. More...
 
QString getText () const
 Gets the action text. More...
 
bool isEnabled () const
 Gets a boolean indicating whether or not this action is able to be triggered. More...
 
- Public Member Functions inherited from synthclone::MenuItem
bool isVisible () const
 Gets a boolean indicating whether or not the item is visible. More...
 

Additional Inherited Members

- Protected Member Functions inherited from synthclone::MenuItem
 MenuItem (QObject *parent=0)
 Constructs a new MenuItem object. More...
 
virtual ~MenuItem ()
 Destroys a MenuItem. More...
 

Detailed Description

MenuAction objects are triggerable choices in a menu.

Constructor & Destructor Documentation

synthclone::MenuAction::MenuAction ( QObject *  parent = 0)
explicit

Constructs an new MenuAction object.

Parameters
parentThe parent object of the new menu action.
synthclone::MenuAction::MenuAction ( const QString &  text,
QObject *  parent = 0 
)
explicit

Constructs a new MenuAction object.

Parameters
textThe default text for the new menu action.
parentThe parent object of the new menu action.
synthclone::MenuAction::MenuAction ( const QString &  text,
const QString &  description,
QObject *  parent = 0 
)

Constructs a new MenuAction object.

Parameters
textThe default text for the new menu action.
descriptionThe default description for the new menu action.
parentThe parent object of the new menu action.
synthclone::MenuAction::~MenuAction ( )

Destroys the MenuAction object.

Member Function Documentation

void synthclone::MenuAction::descriptionChanged ( const QString &  description)
signal

Emitted when the description is changed.

Parameters
descriptionThe new description.
void synthclone::MenuAction::enabledChanged ( bool  enabled)
signal

Emitted when the 'enabled' flag is changed.

Parameters
enabledWhether or not the action is now enabled.
QString synthclone::MenuAction::getDescription ( ) const

Gets the action description.

Returns
The description.
QString synthclone::MenuAction::getText ( ) const

Gets the action text.

Returns
The action text.
bool synthclone::MenuAction::isEnabled ( ) const

Gets a boolean indicating whether or not this action is able to be triggered.

Returns
The specified boolean.
void synthclone::MenuAction::setDescription ( const QString &  description)
slot

Sets the description.

Parameters
descriptionThe description.
void synthclone::MenuAction::setEnabled ( bool  enabled)
slot

Sets a boolean indicating whether or not this action is able to be triggered.

Parameters
enabledThe specified boolean.
void synthclone::MenuAction::setText ( const QString &  text)
slot

Sets the action text.

Parameters
textThe action text.
void synthclone::MenuAction::textChanged ( const QString &  text)
signal

Emitted when the action text is changed.

Parameters
textThe new action text.
void synthclone::MenuAction::trigger ( )
slot

Triggers the action.

This method is called from within synthclone.

void synthclone::MenuAction::triggered ( )
signal

Emitted when this action is triggered.


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