LeechCraft  0.6.70-15082-g543737046d
Modular cross-platform feature rich live environment.
IActionsExporter Class Referenceabstract

Interface for embedding actions and menus into various places. More...

#include "iactionsexporter.h"

Public Member Functions

virtual ~IActionsExporter ()
 
virtual QList< QAction * > GetActions (LC::ActionsEmbedPlace area) const =0
 Returns the actions to embed. More...
 
virtual QMap< QString, QList< QAction * > > GetMenuActions () const
 Returns the actions to embed into the menu. More...
 

Protected Member Functions

virtual void gotActions (QList< QAction * > actions, LC::ActionsEmbedPlace area)=0
 Notifies about new actions for the given area. More...
 

Detailed Description

Interface for embedding actions and menus into various places.

Definition at line 70 of file iactionsexporter.h.

Constructor & Destructor Documentation

◆ ~IActionsExporter()

virtual IActionsExporter::~IActionsExporter ( )
inlinevirtual

Definition at line 73 of file iactionsexporter.h.

Member Function Documentation

◆ GetActions()

virtual QList<QAction*> IActionsExporter::GetActions ( LC::ActionsEmbedPlace  area) const
pure virtual

Returns the actions to embed.

Returns the list of actions that will be inserted into the given area.

Parameters
[in]areaThe area where the actions should be placed.
Returns
The list of actions for the given area.

◆ GetMenuActions()

virtual QMap<QString, QList<QAction*> > IActionsExporter::GetMenuActions ( ) const
inlinevirtual

Returns the actions to embed into the menu.

For each string key found in the returned map, the corresponding list of QActions would be added to the submenu under that name in the main menu. That allows several different plugins to insert actions into one menu easily.

Returns
The map of menu name -> list of its actions.

Definition at line 95 of file iactionsexporter.h.

◆ gotActions()

virtual void IActionsExporter::gotActions ( QList< QAction * >  actions,
LC::ActionsEmbedPlace  area 
)
protectedpure virtual

Notifies about new actions for the given area.

The sender of this signal remains the owner of actions, and it may delete them at any given time.

Note
This function is expected to be a signal.
Parameters
[out]actionsThe list of new actions for the given area.
[out]areaThe area where these actions should be placed.

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