removed wxAcceleratorTable copy ctor docs, no port implements it

[wxWidgets.git] / docs / doxygen / overviews / dialog.h

diff --git a/docs/doxygen/overviews/dialog.h b/docs/doxygen/overviews/dialog.h
index bc01b3b4ace1cffde265427d3f183ffce91138c4..ed2abe382a12384daf6a60d8fbde8b813b1c319c 100644 (file)
--- a/docs/doxygen/overviews/dialog.h
+++ b/docs/doxygen/overviews/dialog.h
@@ -6,11 +6,11 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

-/*!
+/**

 
 

- @page overview_dialog wxDialog overview
+ @page overview_dialog wxDialog Overview

 
 

- Classes: #wxDialog, #wxDialogLayoutAdapter
+ Classes: wxDialog, wxDialogLayoutAdapter

 
  A dialog box is similar to a panel, in that it is a window which can
  be used for placing controls, with the following exceptions:
 
  A dialog box is similar to a panel, in that it is a window which can
  be used for placing controls, with the following exceptions:


@@ -22,12 +22,18 @@
      until the dialog box is dismissed.
 
  For a set of dialog convenience functions, including file selection, see
      until the dialog box is dismissed.
 
  For a set of dialog convenience functions, including file selection, see

- @ref overview_dialogfunctions.
+ @ref page_func_cat_dialog.

 
 

- See also #wxTopLevelWindow and #wxWindow for inherited
+ See also wxTopLevelWindow and wxWindow for inherited

  member functions. Validation of data in controls is covered in @ref overview_validator.
 
 
  member functions. Validation of data in controls is covered in @ref overview_validator.
 
 

+ @li @ref overview_dialog_autoscrolling
+
+
+ <hr>
+
+

 
  @section overview_dialog_autoscrolling Automatic scrolling dialogs
 
 
  @section overview_dialog_autoscrolling Automatic scrolling dialogs
 


@@ -35,7 +41,7 @@
  imperative for wxWidgets applications to adapt to these platforms without putting 
  too much burden on the programmer. One area where wxWidgets can help is in adapting
  dialogs for the lower resolution screens that inevitably accompany a smaller form factor.
  imperative for wxWidgets applications to adapt to these platforms without putting 
  too much burden on the programmer. One area where wxWidgets can help is in adapting
  dialogs for the lower resolution screens that inevitably accompany a smaller form factor.

- wxDialog therefore supplies a global #wxDialogLayoutAdapter class that implements 
+ wxDialog therefore supplies a global wxDialogLayoutAdapter class that implements 

  automatic scrolling adaptation for most sizer-based custom dialogs.
 
  Many applications should therefore be able to adapt to small displays with little 
  automatic scrolling adaptation for most sizer-based custom dialogs.
 
  Many applications should therefore be able to adapt to small displays with little 


@@ -55,13 +61,13 @@
 
  @li If wxDialog::GetContentWindow returns a window derived from wxBookCtrlBase, 
      the pages are made scrollable and no other adaptation is done.
 
  @li If wxDialog::GetContentWindow returns a window derived from wxBookCtrlBase, 
      the pages are made scrollable and no other adaptation is done.

- @li wxWidgets looks for a #wxStdDialogButtonSizer and uses it for the non-scrolling part.
- @li If that search failed, wxWidgets looks for a horizontal #wxBoxSizer with one or more
+ @li wxWidgets looks for a wxStdDialogButtonSizer and uses it for the non-scrolling part.
+ @li If that search failed, wxWidgets looks for a horizontal wxBoxSizer with one or more

      standard buttons, with identifiers such as @c wxID_OK and @c wxID_CANCEL.
  @li If that search failed too, wxWidgets finds 'loose' standard buttons (in any kind of sizer)
      standard buttons, with identifiers such as @c wxID_OK and @c wxID_CANCEL.
  @li If that search failed too, wxWidgets finds 'loose' standard buttons (in any kind of sizer)

-     and adds them to a #wxStdDialogButtonSizer.
+     and adds them to a wxStdDialogButtonSizer.

      If no standard buttons were found, the whole dialog content will scroll.
      If no standard buttons were found, the whole dialog content will scroll.

- @li All the children apart from standard buttons are reparented onto a new #wxScrolledWindow 
+ @li All the children apart from standard buttons are reparented onto a new wxScrolledWindow 

      object, using the old top-level sizer for the scrolled window and creating a new top-level 
      sizer to lay out the scrolled window and standard button sizer.
 
      object, using the old top-level sizer for the scrolled window and creating a new top-level 
      sizer to lay out the scrolled window and standard button sizer.
 


@@ -77,7 +83,7 @@
  You can use wxDialog::AddMainButtonId to add identifiers for buttons that should also be
  treated as standard buttons for the non-scrolling area.
 
  You can use wxDialog::AddMainButtonId to add identifiers for buttons that should also be
  treated as standard buttons for the non-scrolling area.
 

- You can derive your own class from #wxDialogLayoutAdapter or wxStandardDialogLayoutAdapter and call
+ You can derive your own class from wxDialogLayoutAdapter or wxStandardDialogLayoutAdapter and call

  wxDialog::SetLayoutAdapter, deleting the old object that this function returns. Override
  the functions CanDoLayoutAdaptation and DoLayoutAdaptation to test for adaptation applicability
  and perform the adaptation.
  wxDialog::SetLayoutAdapter, deleting the old object that this function returns. Override
  the functions CanDoLayoutAdaptation and DoLayoutAdaptation to test for adaptation applicability
  and perform the adaptation.


@@ -107,7 +113,7 @@
  You can help make sure that your dialogs will continue to function after adaptation by:
 
  @li avoiding the above situations and assumptions;
  You can help make sure that your dialogs will continue to function after adaptation by:
 
  @li avoiding the above situations and assumptions;

- @li using #wxStdDialogButtonSizer;
+ @li using wxStdDialogButtonSizer;

  @li only making assumptions about hierarchy immediately after the dialog is created;
  @li using an intermediate sizer under the main sizer, a @false top-level sizer that 
      can be relied on to exist for the purposes of manipulating child sizers and windows;
  @li only making assumptions about hierarchy immediately after the dialog is created;
  @li using an intermediate sizer under the main sizer, a @false top-level sizer that 
      can be relied on to exist for the purposes of manipulating child sizers and windows;