KVIrc 5.2.0
Developer APIs
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 () const
 Returns the description of the category.
 
 KviActionCategory (QString szName, QString szVisibleName, QString szDescription)
 Constructs an action category object.
 
const QString & name () const
 Returns the name of the category.
 
const QString & visibleName () const
 Returns the visible name of the category.
 

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::KviActionCategory ( QString  szName,
QString  szVisibleName,
QString  szDescription 
)
inline

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

Member Function Documentation

◆ description()

const QString & KviActionCategory::description ( ) const
inline

Returns the description of the category.

Returns
const QString &

Referenced by KviActionDrawer::fill().

◆ name()

const QString & KviActionCategory::name ( ) const
inline

Returns the name of the category.

Returns
const QString &

Referenced by ActionEditor::ActionEditor().

◆ visibleName()

const QString & KviActionCategory::visibleName ( ) const
inline

Returns the visible name of the category.

Returns
const QString &

Referenced by KviActionDrawer::fill().

Member Data Documentation

◆ m_szDescription

QString KviActionCategory::m_szDescription
protected

◆ m_szName

QString KviActionCategory::m_szName
protected

◆ m_szVisibleName

QString KviActionCategory::m_szVisibleName
protected

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