wxDialogHelper Class Reference

#include <uiutils/scrollingdialog.h>

Inheritance diagram for wxDialogHelper:

wxScrollingDialog wxScrollingPropertySheetDialog wxScrollingWizard wxCommandEditorDialog List of all members.

Public Member Functions

 wxDialogHelper (wxDialog *dialog=NULL)
virtual ~wxDialogHelper ()
void Init ()
void SetDialog (wxDialog *dialog)
wxDialog * GetDialog () const
virtual bool DoLayoutAdaptation ()
 Do the adaptation.
virtual bool CanDoLayoutAdaptation ()
 Can we do the adaptation?
virtual wxWindow * GetContentWindow () const
 Returns a content window if there is one.
void AddMainButtonId (wxWindowID id)
 Add an id to the list of custom main button identifiers that should be in the button sizer.
wxArrayInt & GetMainButtonIds ()
bool IsMainButtonId (wxWindowID id) const
 Is this id in the custom main button id array?
void SetLayoutAdaptationLevel (int level)
 Level of adaptation, from none (Level 0) to full (Level 3).
int GetLayoutAdaptationLevel () const
 Get level of adaptation.
void SetLayoutAdaptationMode (wxDialogLayoutAdaptationMode mode)
 Override global adaptation enabled/disabled status.
wxDialogLayoutAdaptationMode GetLayoutAdaptationMode () const
void SetLayoutAdaptationDone (bool adaptationDone)
 Returns true if the adaptation has been done.
bool GetLayoutAdaptationDone () const

Static Public Member Functions

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

Protected Attributes

wxDialog * m_dialog
bool m_layoutAdaptationDone
wxArrayInt m_mainButtonIds
int m_layoutAdaptationLevel
wxDialogLayoutAdaptationMode m_layoutAdaptationMode

Static Protected Attributes

static wxDialogLayoutAdaptersm_layoutAdapter
static bool sm_layoutAdaptation

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.


Constructor & Destructor Documentation

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

virtual wxDialogHelper::~wxDialogHelper (  )  [inline, virtual]


Member Function Documentation

void wxDialogHelper::Init (  ) 

Reimplemented in wxCommandEditorDialog, wxScrollingDialog, and wxScrollingWizard.

void wxDialogHelper::SetDialog ( wxDialog *  dialog  )  [inline]

wxDialog* wxDialogHelper::GetDialog (  )  const [inline]

bool wxDialogHelper::DoLayoutAdaptation (  )  [virtual]

Do the adaptation.

Reimplemented in wxScrollingWizard.

bool wxDialogHelper::CanDoLayoutAdaptation (  )  [virtual]

Can we do the adaptation?

virtual wxWindow* wxDialogHelper::GetContentWindow (  )  const [inline, virtual]

Returns a content window if there is one.

Reimplemented in wxScrollingPropertySheetDialog.

void wxDialogHelper::AddMainButtonId ( wxWindowID  id  )  [inline]

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

wxArrayInt& wxDialogHelper::GetMainButtonIds (  )  [inline]

bool wxDialogHelper::IsMainButtonId ( wxWindowID  id  )  const [inline]

Is this id in the custom main button id array?

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.

int wxDialogHelper::GetLayoutAdaptationLevel (  )  const [inline]

Get level of adaptation.

void wxDialogHelper::SetLayoutAdaptationMode ( wxDialogLayoutAdaptationMode  mode  )  [inline]

Override global adaptation enabled/disabled status.

wxDialogLayoutAdaptationMode wxDialogHelper::GetLayoutAdaptationMode (  )  const [inline]

void wxDialogHelper::SetLayoutAdaptationDone ( bool  adaptationDone  )  [inline]

Returns true if the adaptation has been done.

bool wxDialogHelper::GetLayoutAdaptationDone (  )  const [inline]

wxDialogLayoutAdapter * wxDialogHelper::SetLayoutAdapter ( wxDialogLayoutAdapter adapter  )  [static]

Set layout adapter class, returning old adapter.

static wxDialogLayoutAdapter* wxDialogHelper::GetLayoutAdapter (  )  [inline, static]

static bool wxDialogHelper::IsLayoutAdaptationEnabled (  )  [inline, static]

Global switch for layout adaptation.

static void wxDialogHelper::EnableLayoutAdaptation ( bool  enable  )  [inline, static]


Member Data Documentation

wxDialog* wxDialogHelper::m_dialog [protected]

bool wxDialogHelper::m_layoutAdaptationDone [protected]

wxArrayInt wxDialogHelper::m_mainButtonIds [protected]

int wxDialogHelper::m_layoutAdaptationLevel [protected]

wxDialogLayoutAdaptationMode wxDialogHelper::m_layoutAdaptationMode [protected]

wxDialogLayoutAdapter * wxDialogHelper::sm_layoutAdapter [static, protected]

bool wxDialogHelper::sm_layoutAdaptation [static, protected]


The documentation for this class was generated from the following files:
Generated on Wed May 6 19:20:22 2009 for AxTk by  doxygen 1.5.1