OpenCPN Partial API docs
Loading...
Searching...
No Matches
wxDialogHelper Class Reference

#include <scrollingdialog.h>

Inheritance diagram for wxDialogHelper:
wxScrollingDialog wxScrollingPropertySheetDialog

Public Member Functions

 wxDialogHelper (wxDialog *dialog=NULL)
 
void Init ()
 
void SetDialog (wxDialog *dialog)
 
wxDialog * GetDialog () const
 
virtual bool DoLayoutAdaptation ()
 Do the adaptation. More...
 
virtual bool CanDoLayoutAdaptation ()
 Can we do the adaptation? More...
 
virtual wxWindow * GetContentWindow () const
 Returns a content window if there is one. More...
 
void AddButtonId (wxWindowID id)
 Add an id to the list of custom button identifiers that should be in the button sizer. More...
 
std::vector< int > & GetButtonIds ()
 
bool IsUserButtonId (wxWindowID id)
 Is this id in the custom button id array? More...
 
void SetLayoutAdaptationLevel (int level)
 Level of adaptation, from none (Level 0) to full (Level 3). More...
 
int GetLayoutAdaptationLevel () const
 Get level of adaptation. More...
 
void SetLayoutAdaptationDone (bool adaptationDone)
 Returns true if the adaptation has been done. More...
 
bool GetLayoutAdaptationDone () const
 

Static Public Member Functions

static wxDialogLayoutAdapterSetLayoutAdapter (wxDialogLayoutAdapter *adapter)
 Set layout adapter class, returning old adapter. More...
 
static wxDialogLayoutAdapterGetLayoutAdapter ()
 
static bool GetLayoutAdaptation ()
 Global switch for layout adaptation. More...
 
static void SetLayoutAdaptation (bool enable)
 

Protected Attributes

wxDialog * m_dialog
 
bool m_layoutLayoutAdaptationDone
 
std::vector< int > m_buttonIds
 
int m_layoutAdaptationLevel
 

Static Protected Attributes

static wxDialogLayoutAdaptersm_layoutAdapter = NULL
 
static bool sm_layoutAdaptation = true
 

Detailed Description

A base class for dialogs that have adaptation. In wxWidgets 3.0, this will not be needed since the new functionality will be implemented in wxDialogBase.

Definition at line 101 of file scrollingdialog.h.

Constructor & Destructor Documentation

◆ wxDialogHelper()

wxDialogHelper::wxDialogHelper ( wxDialog *  dialog = NULL)
inline

Definition at line 103 of file scrollingdialog.h.

◆ ~wxDialogHelper()

virtual wxDialogHelper::~wxDialogHelper ( )
inlinevirtual

Definition at line 107 of file scrollingdialog.h.

Member Function Documentation

◆ AddButtonId()

void wxDialogHelper::AddButtonId ( wxWindowID  id)
inline

Add an id to the list of custom button identifiers that should be in the button sizer.

Definition at line 125 of file scrollingdialog.h.

◆ CanDoLayoutAdaptation()

bool wxDialogHelper::CanDoLayoutAdaptation ( )
virtual

Can we do the adaptation?

Definition at line 49 of file scrollingdialog.cpp.

◆ DoLayoutAdaptation()

bool wxDialogHelper::DoLayoutAdaptation ( )
virtual

Do the adaptation.

Definition at line 41 of file scrollingdialog.cpp.

◆ GetButtonIds()

std::vector< int > & wxDialogHelper::GetButtonIds ( )
inline

Definition at line 126 of file scrollingdialog.h.

◆ GetContentWindow()

virtual wxWindow * wxDialogHelper::GetContentWindow ( ) const
inlinevirtual

Returns a content window if there is one.

Reimplemented in wxScrollingPropertySheetDialog.

Definition at line 121 of file scrollingdialog.h.

◆ GetDialog()

wxDialog * wxDialogHelper::GetDialog ( ) const
inline

Definition at line 112 of file scrollingdialog.h.

◆ GetLayoutAdaptation()

static bool wxDialogHelper::GetLayoutAdaptation ( )
inlinestatic

Global switch for layout adaptation.

Definition at line 156 of file scrollingdialog.h.

◆ GetLayoutAdaptationDone()

bool wxDialogHelper::GetLayoutAdaptationDone ( ) const
inline

Definition at line 148 of file scrollingdialog.h.

◆ GetLayoutAdaptationLevel()

int wxDialogHelper::GetLayoutAdaptationLevel ( ) const
inline

Get level of adaptation.

Definition at line 142 of file scrollingdialog.h.

◆ GetLayoutAdapter()

static wxDialogLayoutAdapter * wxDialogHelper::GetLayoutAdapter ( )
inlinestatic

Definition at line 153 of file scrollingdialog.h.

◆ Init()

void wxDialogHelper::Init ( )

Definition at line 35 of file scrollingdialog.cpp.

◆ IsUserButtonId()

bool wxDialogHelper::IsUserButtonId ( wxWindowID  id)
inline

Is this id in the custom button id array?

Definition at line 129 of file scrollingdialog.h.

◆ SetDialog()

void wxDialogHelper::SetDialog ( wxDialog *  dialog)
inline

Definition at line 111 of file scrollingdialog.h.

◆ SetLayoutAdaptation()

static void wxDialogHelper::SetLayoutAdaptation ( bool  enable)
inlinestatic

Definition at line 157 of file scrollingdialog.h.

◆ SetLayoutAdaptationDone()

void wxDialogHelper::SetLayoutAdaptationDone ( bool  adaptationDone)
inline

Returns true if the adaptation has been done.

Definition at line 145 of file scrollingdialog.h.

◆ SetLayoutAdaptationLevel()

void wxDialogHelper::SetLayoutAdaptationLevel ( int  level)
inline

Level of adaptation, from none (Level 0) to full (Level 3).

To disable adaptation, set level 0, for example in your dialog constructor. You might do this if you know that you are displaying on a large screen and you don't want the dialog changed.

Definition at line 139 of file scrollingdialog.h.

◆ SetLayoutAdapter()

wxDialogLayoutAdapter * wxDialogHelper::SetLayoutAdapter ( wxDialogLayoutAdapter adapter)
static

Set layout adapter class, returning old adapter.

Set scrolling adapter class, returning old adapter.

Definition at line 56 of file scrollingdialog.cpp.

Member Data Documentation

◆ m_buttonIds

std::vector<int> wxDialogHelper::m_buttonIds
protected

Definition at line 162 of file scrollingdialog.h.

◆ m_dialog

wxDialog* wxDialogHelper::m_dialog
protected

Definition at line 160 of file scrollingdialog.h.

◆ m_layoutAdaptationLevel

int wxDialogHelper::m_layoutAdaptationLevel
protected

Definition at line 163 of file scrollingdialog.h.

◆ m_layoutLayoutAdaptationDone

bool wxDialogHelper::m_layoutLayoutAdaptationDone
protected

Definition at line 161 of file scrollingdialog.h.

◆ sm_layoutAdaptation

bool wxDialogHelper::sm_layoutAdaptation = true
staticprotected

Definition at line 165 of file scrollingdialog.h.

◆ sm_layoutAdapter

wxDialogLayoutAdapter * wxDialogHelper::sm_layoutAdapter = NULL
staticprotected

Dialog helper. This contains the extra members that in wxWidgets 3.0 will be in wxDialogBase.

Definition at line 164 of file scrollingdialog.h.


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