UIAction Struct Reference

Public Member Functions

 UIAction ()
 
 UIAction (const std::function< void(const UIActionContext &context)> &activate)
 
 UIAction (const std::function< void()> &activate)
 
 UIAction (const std::function< void(const UIActionContext &context)> &activate, const std::function< bool(const UIActionContext &context)> &isValid)
 
 UIAction (const std::function< void()> &activate, const std::function< bool(const UIActionContext &context)> &isValid)
 
 UIAction (const std::function< void(const UIActionContext &context)> &activate, const std::function< bool()> &isValid)
 
 UIAction (const std::function< void()> &activate, const std::function< bool()> &isValid)
 
 UIAction (const UIAction &other)
 
UIActionoperator= (const UIAction &other)
 

Static Public Member Functions

static void registerAction (const QString &name, const QKeySequence &defaultKeyBinding=QKeySequence())
 
static void registerAction (const QString &name, const QList< QKeySequence > &defaultKeyBinding)
 
static void unregisterAction (const QString &name)
 
static void registerTransformActions ()
 
static void registerPluginCommandActions ()
 
static void registerPluginCommandActions (const QString &prefix)
 
static void registerHighlightColorActions (const QString &prefix)
 
static void registerBookmarkActions (const QString &prefix)
 
static void setActionDisplayName (const QString &registeredName, const QString &displayName)
 
static void setActionDisplayName (const QString &registeredName, const std::function< QString()> &displayNameFunc)
 
static void setActionDisplayName (const QString &registeredName, const std::function< QString(const UIActionContext &)> &displayNameFunc)
 
static bool isActionRegistered (const QString &name)
 
static std::set< QString > getAllRegisteredActions ()
 
static QList< QKeySequence > getDefaultKeyBinding (const QString &name)
 
static QList< QKeySequence > getKeyBinding (const QString &name)
 
static QString getActionDisplayName (const QString &name, const UIActionContext &context)
 
static int rawControl ()
 
static int rawMeta ()
 
static void setUserKeyBinding (const QString &name, const QList< QKeySequence > &keyBinding)
 
static void resetKeyBindingToDefault (const QString &name)
 
static void readKeyBindingsFile ()
 
static void writeKeyBindingsFile ()
 

Public Attributes

std::function< void(const UIActionContext &context)> activate
 
std::function< bool(const UIActionContext &context)> isValid
 

Constructor & Destructor Documentation

◆ UIAction() [1/8]

UIAction::UIAction ( )

◆ UIAction() [2/8]

UIAction::UIAction ( const std::function< void(const UIActionContext &context)> &  activate)

◆ UIAction() [3/8]

UIAction::UIAction ( const std::function< void()> &  activate)

◆ UIAction() [4/8]

UIAction::UIAction ( const std::function< void(const UIActionContext &context)> &  activate,
const std::function< bool(const UIActionContext &context)> &  isValid 
)

◆ UIAction() [5/8]

UIAction::UIAction ( const std::function< void()> &  activate,
const std::function< bool(const UIActionContext &context)> &  isValid 
)

◆ UIAction() [6/8]

UIAction::UIAction ( const std::function< void(const UIActionContext &context)> &  activate,
const std::function< bool()> &  isValid 
)

◆ UIAction() [7/8]

UIAction::UIAction ( const std::function< void()> &  activate,
const std::function< bool()> &  isValid 
)

◆ UIAction() [8/8]

UIAction::UIAction ( const UIAction other)

Member Function Documentation

◆ getActionDisplayName()

static QString UIAction::getActionDisplayName ( const QString &  name,
const UIActionContext context 
)
static

◆ getAllRegisteredActions()

static std::set< QString > UIAction::getAllRegisteredActions ( )
static

◆ getDefaultKeyBinding()

static QList< QKeySequence > UIAction::getDefaultKeyBinding ( const QString &  name)
static

◆ getKeyBinding()

static QList< QKeySequence > UIAction::getKeyBinding ( const QString &  name)
static

◆ isActionRegistered()

static bool UIAction::isActionRegistered ( const QString &  name)
static

◆ operator=()

UIAction & UIAction::operator= ( const UIAction other)

◆ rawControl()

static int UIAction::rawControl ( )
static

◆ rawMeta()

static int UIAction::rawMeta ( )
static

◆ readKeyBindingsFile()

static void UIAction::readKeyBindingsFile ( )
static

◆ registerAction() [1/2]

static void UIAction::registerAction ( const QString &  name,
const QKeySequence &  defaultKeyBinding = QKeySequence() 
)
static

◆ registerAction() [2/2]

static void UIAction::registerAction ( const QString &  name,
const QList< QKeySequence > &  defaultKeyBinding 
)
static

◆ registerBookmarkActions()

static void UIAction::registerBookmarkActions ( const QString &  prefix)
static

◆ registerHighlightColorActions()

static void UIAction::registerHighlightColorActions ( const QString &  prefix)
static

◆ registerPluginCommandActions() [1/2]

static void UIAction::registerPluginCommandActions ( )
static

◆ registerPluginCommandActions() [2/2]

static void UIAction::registerPluginCommandActions ( const QString &  prefix)
static

◆ registerTransformActions()

static void UIAction::registerTransformActions ( )
static

◆ resetKeyBindingToDefault()

static void UIAction::resetKeyBindingToDefault ( const QString &  name)
static

◆ setActionDisplayName() [1/3]

static void UIAction::setActionDisplayName ( const QString &  registeredName,
const QString &  displayName 
)
static

◆ setActionDisplayName() [2/3]

static void UIAction::setActionDisplayName ( const QString &  registeredName,
const std::function< QString()> &  displayNameFunc 
)
static

◆ setActionDisplayName() [3/3]

static void UIAction::setActionDisplayName ( const QString &  registeredName,
const std::function< QString(const UIActionContext &)> &  displayNameFunc 
)
static

◆ setUserKeyBinding()

static void UIAction::setUserKeyBinding ( const QString &  name,
const QList< QKeySequence > &  keyBinding 
)
static

◆ unregisterAction()

static void UIAction::unregisterAction ( const QString &  name)
static

◆ writeKeyBindingsFile()

static void UIAction::writeKeyBindingsFile ( )
static

Member Data Documentation

◆ activate

std::function<void(const UIActionContext& context)> UIAction::activate

◆ isValid

std::function<bool(const UIActionContext& context)> UIAction::isValid

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