KVIrc  4.9.2
DeveloperAPIs
Public Member Functions | Protected Attributes | List of all members
KviActionCategory Class Reference

Holds the categories of an action. More...

#include <KviAction.h>

Public Member Functions

const QString & description ()
 Returns the description of the category. More...
 
 KviActionCategory (const QString &szName, const QString &szVisibleName, const QString &szDescription)
 Constructs an action category object. More...
 
const QString & name ()
 Returns the name of the category. More...
 
const QString & visibleName ()
 Returns the visible name of the category. More...
 
 ~KviActionCategory ()
 Destroys an action category object. More...
 

Protected Attributes

QString m_szDescription
 
QString m_szName
 
QString m_szVisibleName
 

Detailed Description

Holds the categories of an action.

Known categories are: general (or empty), irc, script

Constructor & Destructor Documentation

KviActionCategory::KviActionCategory ( const QString &  szName,
const QString &  szVisibleName,
const QString &  szDescription 
)

Constructs an action category object.

Parameters
szNameThe name of the category
szVisibleNamePermanent visible name, visible at least in the action drawer
szDescriptionDescription of the category
Returns
KviActionCategory
KviActionCategory::~KviActionCategory ( )
default

Destroys an action category object.

Member Function Documentation

const QString& KviActionCategory::description ( )
inline

Returns the description of the category.

Returns
const QString &

Referenced by KviActionDrawer::fill().

const QString& KviActionCategory::name ( )
inline

Returns the name of the category.

Returns
const QString &

Referenced by ActionEditor::ActionEditor().

const QString& KviActionCategory::visibleName ( )
inline

Returns the visible name of the category.

Returns
const QString &

Referenced by KviActionDrawer::fill().

Member Data Documentation

QString KviActionCategory::m_szDescription
protected
QString KviActionCategory::m_szName
protected
QString KviActionCategory::m_szVisibleName
protected

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