Audacity  3.0.3
Public Attributes | List of all members
BasicUI::MessageBoxOptions Struct Reference

#include <BasicUI.h>

Collaboration diagram for BasicUI::MessageBoxOptions:
[legend]

Public Member Functions

Chain-call style initializers
MessageBoxOptions && Parent (WindowPlacement *parent_) &&
 
MessageBoxOptions && Caption (TranslatableString caption_) &&
 
MessageBoxOptions && IconStyle (Icon style) &&
 
MessageBoxOptions && ButtonStyle (Button style) &&
 
MessageBoxOptions && DefaultIsNo () &&
 Override the usual defaulting to Yes; affects only the YesNo case. More...
 
MessageBoxOptions && CancelButton () &&
 
MessageBoxOptions && Centered () &&
 Center the dialog on its parent window, if any. More...
 

Public Attributes

WindowPlacementparent { nullptr }
 
TranslatableString caption { DefaultCaption() }
 
Icon iconStyle { Icon::None }
 
Button buttonStyle { Button::Default }
 
bool yesOrOkDefaultButton { true }
 
bool cancelButton { false }
 
bool centered { false }
 

Detailed Description

Definition at line 91 of file BasicUI.h.

Member Function Documentation

◆ ButtonStyle()

MessageBoxOptions&& BasicUI::MessageBoxOptions::ButtonStyle ( Button  style) &&
inline

Definition at line 104 of file BasicUI.h.

105  { buttonStyle = style; return std::move(*this); }

References buttonStyle.

Referenced by ThemeBase::SaveComponents().

Here is the caller graph for this function:

◆ CancelButton()

MessageBoxOptions&& BasicUI::MessageBoxOptions::CancelButton ( ) &&
inline

Definition at line 111 of file BasicUI.h.

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

References cancelButton.

◆ Caption()

MessageBoxOptions&& BasicUI::MessageBoxOptions::Caption ( TranslatableString  caption_) &&
inline

Definition at line 98 of file BasicUI.h.

99  { caption = std::move(caption_); return std::move(*this); }

References caption.

Referenced by CreateDirectory(), and MessageBoxException::DelayedHandlerAction().

Here is the caller graph for this function:

◆ Centered()

MessageBoxOptions&& BasicUI::MessageBoxOptions::Centered ( ) &&
inline

Center the dialog on its parent window, if any.

Definition at line 115 of file BasicUI.h.

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

References centered.

◆ DefaultIsNo()

MessageBoxOptions&& BasicUI::MessageBoxOptions::DefaultIsNo ( ) &&
inline

Override the usual defaulting to Yes; affects only the YesNo case.

Definition at line 108 of file BasicUI.h.

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

References yesOrOkDefaultButton.

◆ IconStyle()

MessageBoxOptions&& BasicUI::MessageBoxOptions::IconStyle ( Icon  style) &&
inline

Definition at line 101 of file BasicUI.h.

102  { iconStyle = style; return std::move(*this); }

References iconStyle.

◆ Parent()

MessageBoxOptions&& BasicUI::MessageBoxOptions::Parent ( WindowPlacement parent_) &&
inline

Definition at line 95 of file BasicUI.h.

96  { parent = parent_; return std::move(*this); }

References parent.

Member Data Documentation

◆ buttonStyle

Button BasicUI::MessageBoxOptions::buttonStyle { Button::Default }

Definition at line 123 of file BasicUI.h.

Referenced by ButtonStyle(), and wxWidgetsBasicUI::DoMessageBox().

◆ cancelButton

bool BasicUI::MessageBoxOptions::cancelButton { false }

Definition at line 125 of file BasicUI.h.

Referenced by CancelButton(), and wxWidgetsBasicUI::DoMessageBox().

◆ caption

TranslatableString BasicUI::MessageBoxOptions::caption { DefaultCaption() }

Definition at line 121 of file BasicUI.h.

Referenced by Caption(), and wxWidgetsBasicUI::DoMessageBox().

◆ centered

bool BasicUI::MessageBoxOptions::centered { false }

Definition at line 126 of file BasicUI.h.

Referenced by Centered(), and wxWidgetsBasicUI::DoMessageBox().

◆ iconStyle

Icon BasicUI::MessageBoxOptions::iconStyle { Icon::None }

Definition at line 122 of file BasicUI.h.

Referenced by wxWidgetsBasicUI::DoMessageBox(), and IconStyle().

◆ parent

WindowPlacement* BasicUI::MessageBoxOptions::parent { nullptr }

Definition at line 120 of file BasicUI.h.

Referenced by wxWidgetsBasicUI::DoMessageBox(), and Parent().

◆ yesOrOkDefaultButton

bool BasicUI::MessageBoxOptions::yesOrOkDefaultButton { true }

Definition at line 124 of file BasicUI.h.

Referenced by DefaultIsNo(), and wxWidgetsBasicUI::DoMessageBox().


The documentation for this struct was generated from the following file:
BasicUI::MessageBoxOptions::cancelButton
bool cancelButton
Definition: BasicUI.h:125
BasicUI::MessageBoxOptions::buttonStyle
Button buttonStyle
Definition: BasicUI.h:123
BasicUI::MessageBoxOptions::iconStyle
Icon iconStyle
Definition: BasicUI.h:122
BasicUI::MessageBoxOptions::yesOrOkDefaultButton
bool yesOrOkDefaultButton
Definition: BasicUI.h:124
BasicUI::MessageBoxOptions::centered
bool centered
Definition: BasicUI.h:126
BasicUI::MessageBoxOptions::parent
WindowPlacement * parent
Definition: BasicUI.h:120
BasicUI::MessageBoxOptions::caption
TranslatableString caption
Definition: BasicUI.h:121