Audacity  3.0.3
Public Types | Public Member Functions | Public Attributes | List of all members
CommandFlagOptions Struct Reference

#include <CommandFlag.h>

Collaboration diagram for CommandFlagOptions:
[legend]

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 38 of file CommandFlag.h.

Member Typedef Documentation

◆ MessageFormatter

Definition at line 41 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 45 of file CommandFlag.h.

47  {},
48  const TranslatableString &title_ = {}
49  ) : message{ message_ }, helpPage{ helpPage_ }, title{ title_ }
50  {}

Member Function Documentation

◆ DisableDefaultMessage()

CommandFlagOptions&& CommandFlagOptions::DisableDefaultMessage ( ) &&
inline

Definition at line 54 of file CommandFlag.h.

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

References enableDefaultMessage.

Referenced by TrackPanelHasFocus(), and TracksExistFlag().

Here is the caller graph for this function:

◆ Priority()

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

Definition at line 56 of file CommandFlag.h.

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

References priority.

◆ QuickTest()

CommandFlagOptions&& CommandFlagOptions::QuickTest ( ) &&
inline

Definition at line 52 of file CommandFlag.h.

53  { 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 77 of file CommandFlag.h.

Referenced by DisableDefaultMessage().

◆ helpPage

wxString CommandFlagOptions::helpPage

Definition at line 64 of file CommandFlag.h.

◆ message

MessageFormatter CommandFlagOptions::message

Definition at line 61 of file CommandFlag.h.

◆ priority

unsigned CommandFlagOptions::priority = 0

Definition at line 73 of file CommandFlag.h.

Referenced by Priority().

◆ quickTest

bool CommandFlagOptions::quickTest = false

Definition at line 82 of file CommandFlag.h.

Referenced by QuickTest().

◆ title

TranslatableString CommandFlagOptions::title

Definition at line 69 of file CommandFlag.h.


The documentation for this struct was generated from the following file:
TranslatableString
Holds a msgid for the translation catalog; may also bind format arguments.
Definition: TranslatableString.h:32
CommandFlagOptions::priority
unsigned priority
Definition: CommandFlag.h:73
CommandFlagOptions::quickTest
bool quickTest
Definition: CommandFlag.h:82
CommandFlagOptions::helpPage
wxString helpPage
Definition: CommandFlag.h:64
CommandFlagOptions::title
TranslatableString title
Definition: CommandFlag.h:69
CommandFlagOptions::message
MessageFormatter message
Definition: CommandFlag.h:61
CommandFlagOptions::enableDefaultMessage
bool enableDefaultMessage
Definition: CommandFlag.h:77