KVIrc 5.2.4
Developer APIs
Public Member Functions | List of all members
KviSeparatorAction Class Reference

#include <KviCoreActions.h>

+ Inheritance diagram for KviSeparatorAction:

Public Member Functions

QAction * addToCustomToolBar (KviCustomToolBar *pTool) override
 Adds the action to the given toolbar.
 
bool addToPopupMenu (QMenu *pMenu) override
 Adds the action to the given popup.
 
 KviSeparatorAction (QObject *pParent)
 
- Public Member Functions inherited from KviAction
QPixmap * bigIcon ()
 Returns the big icon associated to the action.
 
const QString & bigIconId () const
 Returns the id of the big icon associated to the action.
 
KviActionCategorycategory () const
 Returns the category of the action.
 
virtual const QString & description ()
 Returns the description of the action.
 
unsigned int flags () const
 Returns the flag associated to the action.
 
bool isEnabled () const
 Returns true if the action is enabled.
 
virtual bool isKviUserActionNeverOverrideThis ()
 Returns true if the action is user-defined.
 
const QString & keySequence () const
 Returns the shortcut of the action.
 
 KviAction (QObject *pParent, QString szName, QString szVisibleName, QString szDescription, KviActionCategory *pCategory=nullptr, QString szBigIconId=QString(), KviIconManager::SmallIcon eSmallIcon=KviIconManager::None, unsigned int uFlags=0, QString szKeySequence=QString())
 Constructs the action object.
 
 KviAction (QObject *pParent, QString szName, QString szVisibleName, QString szDescription, KviActionCategory *pCategory=nullptr, QString szBigIconId=QString(), QString szSmallIconId=QString(), unsigned int uFlags=0, QString szKeySequence=QString())
 Constructs the action object.
 
const QString & name () const
 Returns the name of the action.
 
virtual void setEnabled (bool bEnabled)
 Enables the action.
 
QPixmap * smallIcon ()
 Returns the small icon associated to the action.
 
const QString & smallIconId () const
 Returns the id of the small icon associated to the action.
 
void suicide ()
 Destroys itself. Maybe the best function in the whole APIs :)
 
virtual const QString & visibleName ()
 Returns the visible name of the action.
 
virtual ~KviAction ()
 Destroys the action object.
 

Additional Inherited Members

- Public Types inherited from KviAction
enum  Flags {
  NeedsContext = 1 , NeedsConnection = 2 , WindowConsole = 4 , WindowChannel = 8 ,
  WindowQuery = 16 , WindowDccChat = 32 , InternalWindowMask = WindowConsole | WindowChannel | WindowQuery | WindowDccChat , EnableAtLogin = 64 ,
  WindowOnlyIfUsersSelected = 128
}
 Holds the flags of an action. More...
 
enum  InternalFlags { Enabled = 1 , SetupDone = 2 }
 Holds the internal flags of an action. More...
 
- Public Slots inherited from KviAction
virtual void activate ()
 Activates the action.
 
- Signals inherited from KviAction
void activated ()
 Emitted when the action is being activated.
 
- Static Public Member Functions inherited from KviAction
static int validateFlags (int iFlagsToValidate)
 Validates the flags of the action.
 
- Protected Slots inherited from KviAction
virtual void actionDestroyed ()
 Removes the action from the list.
 
virtual void activeContextChanged ()
 Enables or disables the action upon checking the active context.
 
virtual void activeContextStateChanged ()
 Enables or disables the action upon checking the active context.
 
virtual void activeWindowChanged ()
 Enables or disables the action upon checking the active window.
 
virtual void activeWindowSelectionStateChanged (bool bSelectedNow)
 Enables or disables the action upon checking the active window.
 
virtual void reloadImages ()
 Reloads the images.
 
- Protected Member Functions inherited from KviAction
std::unordered_set< QAction * > const & actionList () const
 Returns the list of actions associated to the action.
 
void registerAccelerator ()
 Registers the action shortcut in the application.
 
void registerAction (QAction *pAction)
 Adds the action to the list.
 
virtual void setup ()
 Enables or disables the action upon starting KVIrc.
 
bool setupDone () const
 Returns true if the setup is finished.
 
void unregisterAccelerator ()
 Removes the action shortcut from the application.
 
- Protected Attributes inherited from KviAction
KviIconManager::SmallIcon m_eSmallIcon
 
QPointer< QShortcut > m_pAccel
 
std::unordered_set< QAction * > m_pActionList
 
KviActionCategorym_pCategory = nullptr
 
QString m_szBigIconId
 
QString m_szDescription
 
QString m_szKeySequence
 
QString m_szName
 
QString m_szSmallIconId
 
QString m_szVisibleName
 
unsigned int m_uFlags
 
unsigned short int m_uInternalFlags
 

Constructor & Destructor Documentation

◆ KviSeparatorAction()

KviSeparatorAction::KviSeparatorAction ( QObject *  pParent)

Member Function Documentation

◆ addToCustomToolBar()

QAction * KviSeparatorAction::addToCustomToolBar ( KviCustomToolBar pParentToolBar)
overridevirtual

Adds the action to the given toolbar.

Parameters
pParentToolBarThe toolbar where to add the action
Returns
QAction *

Reimplemented from KviAction.

References KVI_COREACTION_SEPARATOR, KviAction::registerAction(), KviAction::setup(), KviAction::setupDone(), t, and w.

◆ addToPopupMenu()

bool KviSeparatorAction::addToPopupMenu ( QMenu *  pMenu)
overridevirtual

Adds the action to the given popup.

Parameters
pMenuThe menu where to add the action
Returns
bool

Reimplemented from KviAction.

References p, KviAction::setup(), and KviAction::setupDone().


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