CommandFlagOptions Struct Reference

#include <CommandFlag.h>

Collaboration diagram for CommandFlagOptions:

Public Types
using	MessageFormatter = std::function< TranslatableString(const TranslatableString &) >

Public Member Functions
	CommandFlagOptions ()=default
	CommandFlagOptions (const MessageFormatter &message_, const wxString &helpPage_={}, const TranslatableString &title_={})
CommandFlagOptions &&	QuickTest () &&
CommandFlagOptions &&	DisableDefaultMessage () &&
CommandFlagOptions &&	Priority (unsigned priority_) &&

Public Attributes
MessageFormatter	message
wxString	helpPage
TranslatableString	title
unsigned	priority = 0
bool	enableDefaultMessage = true
bool	quickTest = false

Detailed Description

Definition at line 37 of file CommandFlag.h.

Member Typedef Documentation

MessageFormatter

using CommandFlagOptions::MessageFormatter = std::function< TranslatableString( const TranslatableString& ) >

Definition at line 40 of file CommandFlag.h.

Constructor & Destructor Documentation

CommandFlagOptions() [1/2]

CommandFlagOptions::CommandFlagOptions ( )

default

CommandFlagOptions() [2/2]

CommandFlagOptions::CommandFlagOptions ( const MessageFormatter &  message_, const wxString &  helpPage_ = {}, const TranslatableString &  title_ = {}  )

inline

Definition at line 44 of file CommandFlag.h.

                                  {},
      const TranslatableString &title_ = {}
   ) : message{ message_ }, helpPage{ helpPage_ }, title{ title_ }
   {}

Member Function Documentation

DisableDefaultMessage()

CommandFlagOptions && CommandFlagOptions::DisableDefaultMessage ( ) &&

inline

Definition at line 53 of file CommandFlag.h.

   { enableDefaultMessage = false; return std::move( *this ); }

References enableDefaultMessage.

Referenced by anonymous_namespace{EditMenus.cpp}::CutCopyAvailableFlag(), anonymous_namespace{EditMenus.cpp}::JoinClipsAvailableFlag(), TrackPanelHasFocus(), and TracksExistFlag().

Here is the caller graph for this function:

Priority()

CommandFlagOptions && CommandFlagOptions::Priority ( unsigned  priority_ ) &&

inline

Definition at line 55 of file CommandFlag.h.

   { priority = priority_; return std::move( *this ); }

References priority.

QuickTest()

CommandFlagOptions && CommandFlagOptions::QuickTest ( ) &&

inline

Definition at line 51 of file CommandFlag.h.

   { quickTest = true; return std::move( *this ); }

References quickTest.

Referenced by AudioIOBusyFlag(), NotMinimizedFlag(), and PausedFlag().

Here is the caller graph for this function:

Member Data Documentation

enableDefaultMessage

bool CommandFlagOptions::enableDefaultMessage = true

Definition at line 76 of file CommandFlag.h.

Referenced by DisableDefaultMessage().

helpPage

wxString CommandFlagOptions::helpPage

Definition at line 63 of file CommandFlag.h.

message

MessageFormatter CommandFlagOptions::message

Definition at line 60 of file CommandFlag.h.

priority

unsigned CommandFlagOptions::priority = 0

Definition at line 72 of file CommandFlag.h.

Referenced by Priority().

quickTest

bool CommandFlagOptions::quickTest = false

Definition at line 81 of file CommandFlag.h.

Referenced by QuickTest().

title

TranslatableString CommandFlagOptions::title

Definition at line 68 of file CommandFlag.h.

---

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

• CommandFlag.h