This class handles the actions. More...

#include <KviKvsAction.h>

Inheritance diagram for KviKvsAction:

Public Member Functions
virtual void	activate ()
	Executes the action. More...

	KviKvsAction (QObject pParent, const QString &szName, const QString &szScriptCode, const QString &szVisibleName, const QString &szDescription, KviActionCategory pCategory=NULL, const QString &szBigIconId=QString(), const QString &szSmallIconId=QString(), unsigned int uFlags=0, const QString &szKeySequence=QString())
	Contructs the action object. More...

	KviKvsAction (QObject pParent, const QString &szName, const QString &szScriptCode, const QString &szVisibleName, const QString &szDescription, KviActionCategory pCategory=NULL, const QString &szBigIconId=QString(), KviIconManager::SmallIcon eSmallIcon=KviIconManager::None, unsigned int uFlags=0, const QString &szKeySequence=QString())
	Contructs the action object. More...

const QString &	scriptCode ()
	Returns the code of the script contained in the action. More...

virtual	~KviKvsAction ()
	Destroys the action object. More...

Public Member Functions inherited from KviAction
virtual QAction *	addToCustomToolBar (KviCustomToolBar *pParentToolBar)
	Adds the action to the given toolbar. More...

virtual bool	addToPopupMenu (QMenu *pMenu)
	Adds the action to the given popup. More...

QPixmap *	bigIcon ()
	Returns the big icon associated to the action. More...

const QString &	bigIconId () const
	Returns the id of the big icon associated to the action. More...

KviActionCategory *	category () const
	Returns the category of the action. More...

virtual const QString &	description ()
	Returns the description of the action. More...

unsigned int	flags ()
	Returns the flag associated to the action. More...

bool	isEnabled () const
	Returns true if the action is enabled. More...

virtual bool	isKviUserActionNeverOverrideThis ()
	Returns true if the action is user-defined. More...

const QString &	keySequence () const
	Returns the shortcut of the action. More...

	KviAction (QObject pParent, const QString &szName, const QString &szVisibleName, const QString &szDescription, KviActionCategory pCategory=NULL, const QString &szBigIconId=QString(), const QString &szSmallIconId=QString(), unsigned int uFlags=0, const QString &szKeySequence=QString())
	Constructs the action object. More...

	KviAction (QObject pParent, const QString &szName, const QString &szVisibleName, const QString &szDescription, KviActionCategory pCategory=NULL, const QString &szBigIconId=QString(), KviIconManager::SmallIcon eSmallIcon=KviIconManager::None, unsigned int uFlags=0, const QString &szKeySequence=QString())
	Constructs the action object. More...

const QString &	name () const
	Returns the name of the action. More...

virtual void	setEnabled (bool bEnabled)
	Enables the action. More...

QPixmap *	smallIcon ()
	Returns the small icon associated to the action. More...

const QString &	smallIconId () const
	Returns the id of the small icon associated to the action. More...

void	suicide ()
	Destroys itself. Maybe the best function in the whole APIs :) More...

virtual const QString &	visibleName ()
	Returns the visible name of the action. More...

virtual	~KviAction ()
	Destroys the action object. More...

Protected Attributes
QString	m_szScript

Protected Attributes inherited from KviAction
KviIconManager::SmallIcon	m_eSmallIcon

QPointer< QShortcut >	m_pAccel

KviPointerList< QAction > *	m_pActionList

KviActionCategory *	m_pCategory

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

Static Public Member Functions inherited from KviAction
static int	validateFlags (int iFlagsToValidate)
	Validates the flags of the action. More...

Protected Slots inherited from KviAction
virtual void	actionDestroyed ()
	Removes the action from the list. More...

virtual void	activeContextChanged ()
	Enables or disables the action upon checking the active context. More...

virtual void	activeContextStateChanged ()
	Enables or disables the action upon checking the active context. More...

virtual void	activeWindowChanged ()
	Enables or disables the action upon checking the active window. More...

virtual void	activeWindowSelectionStateChanged (bool bSelectedNow)
	Enables or disables the action upon checking the active window. More...

virtual void	reloadImages ()
	Reloads the images. More...

Protected Member Functions inherited from KviAction
KviPointerList< QAction > *	actionList ()
	Returns the list of actions associated to the action. More...

void	registerAccelerator ()
	Registers the action shortcut in the application. More...

void	registerAction (QAction *pAction)
	Adds the action to the list. More...

virtual void	setup ()
	Enables or disables the action upon starting KVIrc. More...

bool	setupDone () const
	Returns true if the setup is finished. More...

void	unregisterAccelerator ()
	Removes the action shortcut from the application. More...

Detailed Description

This class handles the actions.

Constructor & Destructor Documentation

KviKvsAction::KviKvsAction	(	QObject *	pParent,
		const QString &	szName,
		const QString &	szScriptCode,
		const QString &	szVisibleName,
		const QString &	szDescription,
		KviActionCategory *	pCategory = `NULL`,
		const QString &	szBigIconId = `QString()`,
		const QString &	szSmallIconId = `QString()`,
		unsigned int	uFlags = `0`,
		const QString &	szKeySequence = `QString()`
	)

Contructs the action object.

Parameters

pParent	The parent object
szName	The name of the action
szScriptCode	The code of the script contained in the action
szVisibleName	Permanent visible name, visible at least in the action drawer
szDescription	The description of the action
pCategory	One of KviActionManager::category*() or 0 (default category)
szBigIconId	The id of a big icon (32x32)
szSmallIconId	The id of a small icon (16x16)
uFlags	Flags of the action like connection needed, context needed, ...
szKeySequence	The shortcut to activate the action

Returns: KviKvsAction

References m_szScript.

KviKvsAction::KviKvsAction	(	QObject *	pParent,
		const QString &	szName,
		const QString &	szScriptCode,
		const QString &	szVisibleName,
		const QString &	szDescription,
		KviActionCategory *	pCategory = `NULL`,
		const QString &	szBigIconId = `QString()`,
		KviIconManager::SmallIcon	eSmallIcon = `KviIconManager::None`,
		unsigned int	uFlags = `0`,
		const QString &	szKeySequence = `QString()`
	)

Contructs the action object.

Parameters

pParent	The parent object
szName	The name of the action
szScriptCode	The code of the script contained in the action
szVisibleName	Permanent visible name, visible at least in the action drawer
szDescription	The description of the action
pCategory	One of KviActionManager::category*() or 0 (default category)
szBigIconId	The id of a big icon (32x32)
szSmallIconId	The id of a small icon (16x16)
uFlags	Flags of the action like connection needed, context needed, ...
szKeySequence	The shortcut to activate the action