KVIrc 5.2.4
Developer APIs
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KviGoAwayAction Class Reference

#include <KviCoreActions.h>

+ Inheritance diagram for KviGoAwayAction:

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.
 
 KviGoAwayAction (QObject *pParent)
 
- Public Member Functions inherited from KviKvsAction
virtual void activate ()
 Executes the action.
 
 KviKvsAction (QObject *pParent, const QString &szName, const QString &szScriptCode, const QString &szVisibleName, const QString &szDescription, KviActionCategory *pCategory=nullptr, const QString &szBigIconId=QString(), const QString &szSmallIconId=QString(), unsigned int uFlags=0, const QString &szKeySequence=QString())
 Constructs the action object.
 
 KviKvsAction (QObject *pParent, const QString &szName, const QString &szScriptCode, const QString &szVisibleName, const QString &szDescription, KviActionCategory *pCategory=nullptr, const QString &szBigIconId=QString(), KviIconManager::SmallIcon eSmallIcon=KviIconManager::None, unsigned int uFlags=0, const QString &szKeySequence=QString())
 Constructs the action object.
 
const QString & scriptCode ()
 Returns the code of the script contained in the action.
 
virtual ~KviKvsAction ()
 Destroys the action object.
 
- 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.
 

Protected Member Functions

void activeContextChanged () override
 Enables or disables the action upon checking the active context.
 
void activeContextStateChanged () override
 Enables or disables the action upon checking the active context.
 
void reloadImages () override
 Reloads the images.
 
void setup () override
 Enables or disables the action upon starting KVIrc.
 
- 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.
 
bool setupDone () const
 Returns true if the setup is finished.
 
void unregisterAccelerator ()
 Removes the action shortcut from the application.
 

Protected Attributes

QString m_szAwayString
 
QString m_szBackString
 
- Protected Attributes inherited from KviKvsAction
QString m_szScript
 
- 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
 

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
- 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 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.
 

Constructor & Destructor Documentation

◆ KviGoAwayAction()

KviGoAwayAction::KviGoAwayAction ( QObject *  pParent)

Member Function Documentation

◆ activeContextChanged()

void KviGoAwayAction::activeContextChanged ( )
overrideprotectedvirtual

Enables or disables the action upon checking the active context.

If the context doesn't exist, the action is disabled

Called when the frame changes the active context.

Note
It works only if NeedsContext is specified
Returns
void

Reimplemented from KviAction.

◆ activeContextStateChanged()

void KviGoAwayAction::activeContextStateChanged ( )
overrideprotectedvirtual

Enables or disables the action upon checking the active context.

Called when the frame changes the state of the context

Returns
void

Reimplemented from KviAction.

◆ addToCustomToolBar()

QAction * KviGoAwayAction::addToCustomToolBar ( KviCustomToolBar pParentToolBar)
overridevirtual

Adds the action to the given toolbar.

Parameters
pParentToolBarThe toolbar where to add the action
Returns
QAction *

Reimplemented from KviAction.

◆ addToPopupMenu()

bool KviGoAwayAction::addToPopupMenu ( QMenu *  pMenu)
overridevirtual

Adds the action to the given popup.

Parameters
pMenuThe menu where to add the action
Returns
bool

Reimplemented from KviAction.

◆ reloadImages()

void KviGoAwayAction::reloadImages ( )
overrideprotectedvirtual

Reloads the images.

Called when the application wants to refresh the images in the toolbar

Returns
void

Reimplemented from KviAction.

◆ setup()

void KviGoAwayAction::setup ( )
overrideprotectedvirtual

Enables or disables the action upon starting KVIrc.

Returns
void

Reimplemented from KviAction.

Member Data Documentation

◆ m_szAwayString

QString KviGoAwayAction::m_szAwayString
protected

◆ m_szBackString

QString KviGoAwayAction::m_szBackString
protected

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