gui::OperatorHint Class Reference

Mode controller wrapper. More...

#include <operatorhint.h>

List of all members.

Public Member Functions

OperatorHinter * get ()
QString hint (const QString &operatorName)
 ~OperatorHint ()

Static Public Member Functions

static OperatorHint * getInstance ()

Private Member Functions

 OperatorHint ()

Detailed Description

Mode controller wrapper.

OperatorHint - class providing wrapper around single OperatorHinter instance and managing its configuration

Constructor & Destructor Documentation

gui::OperatorHint::~OperatorHint (  ) 

Destructor

gui::OperatorHint::OperatorHint (  )  [private]

Constructor Class will be initialized and also configuration will be read, if specified in the settings

Referenced by getInstance().

Member Function Documentation

OperatorHinter * gui::OperatorHint::get (  ) 

Return instance of OperatorHinter that is being used by this class

Returns:
OperatorHinter instance
OperatorHint * gui::OperatorHint::getInstance (  )  [static]

Return Instance of OperatorHint. Ensures only one instance of OperatorHint exists at any time (singleton) If no instance exists, it is created.

Returns:
existing OperatorHint object

References OperatorHint(), and gui::OperatorHintInstance.

Referenced by gui::TreeItemPdfOperator::itemHint().

QString gui::OperatorHint::hint ( const QString &  operatorName  ) 

For given operator name return its description

Parameters:
operatorName name of the operator
Returns:
description of operator

Referenced by gui::TreeItemPdfOperator::itemHint().

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