SUIT_FoundActionTree Class Reference

#include <SUIT_FindActionDialog.h>

Inheritance diagram for SUIT_FoundActionTree:

Public Types
enum	ColumnIdx { Name , ToolTip , KeySequence }
enum class	SortKey {   MatchMetrics , ID , Name , ToolTip ,   KeySequence }

Public Member Functions
	SUIT_FoundActionTree (SUIT_FindActionWidget *theParent, 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_FoundActionTree (const SUIT_FoundActionTree &)=delete
SUIT_FoundActionTree &	operator= (const SUIT_FoundActionTree &)=delete
virtual	~SUIT_FoundActionTree ()=default
void	updateItems (const std::map< QString, std::map< QString, SUIT_ActionSearcher::AssetsAndSearchData >> &theActionAssetsAndSD)
void	sort (SUIT_FoundActionTree::SortKey theKey, Qt::SortOrder theOrder)
void	keyPressEvent (QKeyEvent *theEvent)

Static Public Member Functions
static std::pair< QString, bool >	getKeySequenceFromShortcutMgr (const QString &theModuleID, const QString &theInModuleActionID)
	Default key sequence getter. More...

Public Attributes
const QString	myActionItemToolTip
const bool	myEnableItemsOfUnavailableActions
const bool	myShowKeySequenceColumn
const std::function< std::pair< QString, bool >const QString &, const QString &)>	myKeySequenceGetter
	std::pair<QString, bool> getKeySequence(theModuleID, theInModuleActionID). More...

Static Public Attributes
static const QList< std::pair< SUIT_FoundActionTree::SortKey, Qt::SortOrder > >	DEFAULT_SORT_SCHEMA

Protected Member Functions
bool	eventFilter (QObject *theQObject, QEvent *theEvent)

Private Slots
void	onItemExecuted (QTreeWidgetItem *theWidgetItem, int theColIdx)

Private Member Functions
std::pair< SUIT_FoundActionTreeModule *, int >	findModuleItem (const QString &theModuleID) const
std::set< SUIT_FoundActionTreeAction *, std::function< bool(SUIT_FoundActionTreeAction *, SUIT_FoundActionTreeAction *)> >	createActionSetWithComparator () const

Private Attributes
SUIT_FoundActionTree::SortKey	mySortKey
Qt::SortOrder	mySortOrder
std::map< QString, bool >	myModuleItemExpansionStates
	{moduleID, isExpanded}[] More...

Member Enumeration Documentation

ColumnIdx

enum SUIT_FoundActionTree::ColumnIdx

Enumerator
Name
ToolTip
KeySequence

SortKey

enum SUIT_FoundActionTree::SortKey

strong

Enumerator
MatchMetrics
ID
Name
ToolTip
KeySequence

Constructor & Destructor Documentation

SUIT_FoundActionTree() [1/2]

SUIT_FoundActionTree::SUIT_FoundActionTree	(	SUIT_FindActionWidget *	theParent,
		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&)>()
	)

Parameters

theKeySequenceGetter

If default or empty, SUIT_FoundActionTree::getKeySequenceFromShortcutMgr is used.

References MatchMetrics, myShowKeySequenceColumn, mySortKey, mySortOrder, and onItemExecuted().

SUIT_FoundActionTree() [2/2]

SUIT_FoundActionTree::SUIT_FoundActionTree ( const SUIT_FoundActionTree &  )

delete

~SUIT_FoundActionTree()

virtual SUIT_FoundActionTree::~SUIT_FoundActionTree ( )

virtualdefault

Member Function Documentation

createActionSetWithComparator()

std::set< SUIT_FoundActionTreeAction *, std::function< bool(SUIT_FoundActionTreeAction *, SUIT_FoundActionTreeAction *)> > SUIT_FoundActionTree::createActionSetWithComparator ( ) const

private

References approximatelyEqual(), DEFAULT_SORT_SCHEMA, SUIT_FoundActionTreeAction::getValue(), mySortKey, and mySortOrder.

eventFilter()

bool SUIT_FoundActionTree::eventFilter ( QObject *  theQObject, QEvent *  theEvent  )

protected

References keyPressEvent().

findModuleItem()

std::pair< SUIT_FoundActionTreeModule *, int > SUIT_FoundActionTree::findModuleItem ( const QString &  theModuleID ) const

private

References SUIT_FoundActionTreeItem::myModuleID.

getKeySequenceFromShortcutMgr()

std::pair< QString, bool > SUIT_FoundActionTree::getKeySequenceFromShortcutMgr ( const QString &  theModuleID, const QString &  theInModuleActionID  )

static

Default key sequence getter.

Returns

{keySequence, false}

References SUIT_ShortcutMgr::get().

keyPressEvent()

void SUIT_FoundActionTree::keyPressEvent

(

QKeyEvent *

theEvent

)

References onItemExecuted().

onItemExecuted

void SUIT_FoundActionTree::onItemExecuted ( QTreeWidgetItem *  theWidgetItem, int  theColIdx  )

privateslot

References SUIT_FoundActionTreeAction::myInModuleActionID, SUIT_FoundActionTreeItem::myModuleID, and SUIT_FoundActionTreeItem::type().

operator=()

SUIT_FoundActionTree& SUIT_FoundActionTree::operator= ( const SUIT_FoundActionTree &  )

delete

sort()

void SUIT_FoundActionTree::sort	(	SUIT_FoundActionTree::SortKey	theKey,
		Qt::SortOrder	theOrder
	)

References createActionSetWithComparator(), mySortKey, and mySortOrder.

updateItems()

void SUIT_FoundActionTree::updateItems

(

const std::map< QString, std::map< QString, SUIT_ActionSearcher::AssetsAndSearchData >> &

theActionAssetsAndSD

)

References SUIT_FoundActionTreeAction::create(), createActionSetWithComparator(), SUIT_ShortcutMgr::currentLang(), SUIT_tools::distanceFromBegin(), findModuleItem(), SUIT_ShortcutMgr::get(), SUIT_ShortcutMgr::makeActionID(), SUIT_FoundActionTreeAction::matchMetrics(), myActionItemToolTip, myKeySequenceGetter, SUIT_FoundActionTreeItem::myModuleID, myModuleItemExpansionStates, myShowKeySequenceColumn, SUIT_FoundActionTreeModule::setAssets(), ShCutDbg(), and SUIT_FoundActionTreeItem::styleAsDimmed().

Member Data Documentation

DEFAULT_SORT_SCHEMA

const QList< std::pair< SUIT_FoundActionTree::SortKey, Qt::SortOrder > > SUIT_FoundActionTree::DEFAULT_SORT_SCHEMA

static

Initial value:

=
{
  {SUIT_FoundActionTree::SortKey::MatchMetrics, Qt::SortOrder::AscendingOrder},
  {SUIT_FoundActionTree::SortKey::Name, Qt::SortOrder::AscendingOrder},
  {SUIT_FoundActionTree::SortKey::ToolTip, Qt::SortOrder::AscendingOrder},
  {SUIT_FoundActionTree::SortKey::ID, Qt::SortOrder::AscendingOrder},
  {SUIT_FoundActionTree::SortKey::KeySequence, Qt::SortOrder::AscendingOrder}
}

myActionItemToolTip

const QString SUIT_FoundActionTree::myActionItemToolTip

myEnableItemsOfUnavailableActions

const bool SUIT_FoundActionTree::myEnableItemsOfUnavailableActions

myKeySequenceGetter

const std::function<std::pair<QString, bool>const QString&, const QString&)> SUIT_FoundActionTree::myKeySequenceGetter

std::pair<QString, bool> getKeySequence(theModuleID, theInModuleActionID).

Returns true, if KeySequence column of an action item must be styled as modified.

myModuleItemExpansionStates

std::map<QString, bool> SUIT_FoundActionTree::myModuleItemExpansionStates

private

{moduleID, isExpanded}[]

myShowKeySequenceColumn

const bool SUIT_FoundActionTree::myShowKeySequenceColumn

mySortKey

SUIT_FoundActionTree::SortKey SUIT_FoundActionTree::mySortKey

private

mySortOrder

Qt::SortOrder SUIT_FoundActionTree::mySortOrder

private

---

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

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