SUIT_FindActionWidget Class Reference

#include <SUIT_FindActionDialog.h>

Inheritance diagram for SUIT_FindActionWidget:

Public Member Functions
	SUIT_FindActionWidget (QWidget *theParent, const std::function< void(const QString &, const QString &)> theCallback, const QString &theActionItemToolTip, bool theEnableItemsOfUnavailableActions=false, bool theShowKeySequenceColumn=false, const std::function< std::pair< QString, bool >(const QString &, const QString &)> &theKeySequenceGetter=std::function< std::pair< QString, bool >(const QString &, const QString &)>())
	SUIT_FindActionWidget (const SUIT_FindActionWidget &)=delete
SUIT_FindActionWidget &	operator= (const SUIT_FindActionWidget &)=delete
virtual	~SUIT_FindActionWidget ()=default
void	showOptions (bool theToShow)
void	setIncludedModuleIDs (const std::set< QString > &theModuleIDs={}, bool doNotUpdateResults=false)
const std::set< QString > &	getIncludedModuleIDs () const
void	updateUI ()
	No need to call it, if expected search result changes are triggered by interaction with subwidgets. More...
void	setColumnWidth (int theColumnIdx, int theColumnWidth)

Public Attributes
const std::function< void(const QString &, const QString &)>	myCallback
	void callback(theModuleID, theInModuleActionID) More...

Private Slots
void	onQueryChanged (const QString &theKeyword)
void	onSearchOptionUnavailableActionsChanged (int)
void	onSearchOptionInactiveModulesChanged (int)

Private Attributes
QLineEdit *	myQueryLineEdit
QCheckBox *	myIncludeUnavailableActionsCB
QCheckBox *	myIncludeInactiveModulesCB
SUIT_FoundActionTree *	myFoundActionsTree
std::set< QString >	myIncludedModuleIDs
SUIT_ActionSearcher	myActionSearcher

Constructor & Destructor Documentation

SUIT_FindActionWidget() [1/2]

SUIT_FindActionWidget::SUIT_FindActionWidget	(	QWidget *	theParent,
		const std::function< void(const QString &, const QString &)>	theCallback,
		const QString &	theActionItemToolTip,
		bool	theEnableItemsOfUnavailableActions = false,
		bool	theShowKeySequenceColumn = false,
		const std::function< std::pair< QString, bool >(const QString &, const QString &)> &	theKeySequenceGetter = std::function<std::pair<QString, bool>(const QString&, const QString&)>()
	)

References SUIT_ActionSearcher::includeDisabledActions(), myActionSearcher, myFoundActionsTree, myIncludeInactiveModulesCB, myIncludeUnavailableActionsCB, myQueryLineEdit, onQueryChanged(), onSearchOptionInactiveModulesChanged(), onSearchOptionUnavailableActionsChanged(), SUIT_ActionSearcher::setFieldsToMatch(), and SUIT_ActionSearcher::setKeySequenceGetter().

SUIT_FindActionWidget() [2/2]

SUIT_FindActionWidget::SUIT_FindActionWidget ( const SUIT_FindActionWidget &  )

delete

~SUIT_FindActionWidget()

virtual SUIT_FindActionWidget::~SUIT_FindActionWidget ( )

virtualdefault

Member Function Documentation

getIncludedModuleIDs()

const std::set< QString > & SUIT_FindActionWidget::getIncludedModuleIDs

(

)

const

References myIncludedModuleIDs.

onQueryChanged

void SUIT_FindActionWidget::onQueryChanged ( const QString &  theKeyword )

privateslot

References myActionSearcher, SUIT_ActionSearcher::setQuery(), and updateUI().

onSearchOptionInactiveModulesChanged

void SUIT_FindActionWidget::onSearchOptionInactiveModulesChanged ( int  theState )

privateslot

References SUIT_ShortcutMgr::get(), myActionSearcher, myIncludedModuleIDs, myIncludeUnavailableActionsCB, SUIT_ActionSearcher::setIncludedModuleIDs(), and updateUI().

onSearchOptionUnavailableActionsChanged

void SUIT_FindActionWidget::onSearchOptionUnavailableActionsChanged ( int  theState )

privateslot

References SUIT_ActionSearcher::includeDisabledActions(), myActionSearcher, and updateUI().

operator=()

SUIT_FindActionWidget& SUIT_FindActionWidget::operator= ( const SUIT_FindActionWidget &  )

delete

setColumnWidth()

void SUIT_FindActionWidget::setColumnWidth	(	int	theColumnIdx,
		int	theColumnWidth
	)

References myFoundActionsTree.

setIncludedModuleIDs()

void SUIT_FindActionWidget::setIncludedModuleIDs	(	const std::set< QString > &	theModuleIDs = {},
		bool	doNotUpdateResults = false
	)

Parameters

doNotUpdateResults

Set to true to initialize the instance without unnecessary computations.

References myActionSearcher, myIncludedModuleIDs, SUIT_ShortcutMgr::ROOT_MODULE_ID, SUIT_ActionSearcher::setIncludedModuleIDs(), and updateUI().

showOptions()

void SUIT_FindActionWidget::showOptions

(

bool

theToShow

)

References myIncludeInactiveModulesCB, and myIncludeUnavailableActionsCB.

updateUI()

void SUIT_FindActionWidget::updateUI

(

)

No need to call it, if expected search result changes are triggered by interaction with subwidgets.

References SUIT_ActionSearcher::getSearchResults(), myActionSearcher, myFoundActionsTree, and SUIT_FoundActionTree::updateItems().

Member Data Documentation

myActionSearcher

SUIT_ActionSearcher SUIT_FindActionWidget::myActionSearcher

private

myCallback

const std::function<void(const QString&, const QString&)> SUIT_FindActionWidget::myCallback

void callback(theModuleID, theInModuleActionID)

myFoundActionsTree

SUIT_FoundActionTree* SUIT_FindActionWidget::myFoundActionsTree

private

myIncludedModuleIDs

std::set<QString> SUIT_FindActionWidget::myIncludedModuleIDs

private

myIncludeInactiveModulesCB

QCheckBox* SUIT_FindActionWidget::myIncludeInactiveModulesCB

private

myIncludeUnavailableActionsCB

QCheckBox* SUIT_FindActionWidget::myIncludeUnavailableActionsCB

private

myQueryLineEdit

QLineEdit* SUIT_FindActionWidget::myQueryLineEdit

private

---

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

• src/SUIT/SUIT_FindActionDialog.h
• src/SUIT/SUIT_FindActionDialog.cxx