MantidQt::MantidWidgets::HintStrategy Class Reference

HintStrategy : Provides an interface for generating hints to be used by a HintingLineEdit. More...

#include <HintStrategy.h>

Inheritance diagram for MantidQt::MantidWidgets::HintStrategy:

Public Member Functions
virtual std::vector< Hint >	createHints ()=0
	Create a list of hints for auto completion. More...
	HintStrategy ()
virtual	~HintStrategy ()=default

Detailed Description

HintStrategy : Provides an interface for generating hints to be used by a HintingLineEdit.

Definition at line 19 of file HintStrategy.h.

Constructor & Destructor Documentation

HintStrategy()

MantidQt::MantidWidgets::HintStrategy::HintStrategy ( )

inline

Definition at line 21 of file HintStrategy.h.

~HintStrategy()

virtual MantidQt::MantidWidgets::HintStrategy::~HintStrategy ( )

virtualdefault

Member Function Documentation

createHints()

virtual std::vector< Hint > MantidQt::MantidWidgets::HintStrategy::createHints ( )

pure virtual

Create a list of hints for auto completion.

This is overwritten on the python side. However, leaving this as abstract method causes SIP issues in _common.sip

Returns

A map of keywords to short descriptions for the keyword.

Implemented in MantidQt::MantidWidgets::AlgorithmHintStrategy.

---

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

• qt/widgets/common/inc/MantidQtWidgets/Common/HintStrategy.h