]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/propdlg.h
some more comments about wxSortedArrayString::Sort
[wxWidgets.git] / interface / propdlg.h
index b4e652d0f322b869862a4dbc5f993961b813cf47..1fda28cf00449d0f858b1c7a612ee964cbe6dde0 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        propdlg.h
-// Purpose:     documentation for wxPropertySheetDialog class
+// Purpose:     interface of wxPropertySheetDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,55 +9,55 @@
 /**
     @class wxPropertySheetDialog
     @wxheader{propdlg.h}
-    
+
     This class represents a property sheet dialog: a tabbed dialog
     for showing settings. It is optimized to show flat tabs
     on PocketPC devices, and can be customized to use different
     controllers instead of the default notebook style.
-    
+
     To use this class, call wxPropertySheetDialog::Create from your own
     Create function. Then call wxPropertySheetDialog::CreateButtons, and create
     pages, adding them to the book control.
     Finally call wxPropertySheetDialog::LayoutDialog.
-    
+
     For example:
-    
+
     @code
     bool MyPropertySheetDialog::Create(...)
     {
         if (!wxPropertySheetDialog::Create(...))
             return @false;
-    
+
         CreateButtons(wxOK|wxCANCEL|wxHELP);
-    
+
         // Add page
         wxPanel* panel = new wxPanel(GetBookCtrl(), ...);
         GetBookCtrl()-AddPage(panel, wxT("General"));
-    
+
         LayoutDialog();
         return @true;
     }
     @endcode
-    
+
     If necessary, override CreateBookCtrl and AddBookCtrl to create and add a
     different
     kind of book control. You would then need to use two-step construction for the
     dialog.
     Or, change the style of book control by calling
-    wxPropertySheetDialog::SetSheetStyle 
+    wxPropertySheetDialog::SetSheetStyle
     before calling Create.
-    
+
     The dialogs sample shows this class being used with notebook and toolbook
     controllers (for
     Windows-style and Mac-style settings dialogs).
-    
+
     To make pages of the dialog scroll when the display is too small to fit the
     whole dialog, you can switch
     layout adaptation on globally with wxDialog::EnableLayoutAdaptation or
     per dialog with wxDialog::SetLayoutAdaptationMode. For more
     about layout adaptation, see @ref overview_autoscrollingdialogs "Automatic
     scrolling dialogs".
-    
+
     @library{wxadv}
     @category{managedwnd}
 */
@@ -104,30 +104,30 @@ public:
         wxDialog::CreateButtonSizer, and
         the flags are the same. On PocketPC, no buttons are created.
     */
-    void CreateButtons(int flags=wxOK|wxCANCEL);
+    void CreateButtons(int flags = wxOK|wxCANCEL);
 
     /**
         Returns the book control that will contain your settings pages.
     */
-    wxBookCtrlBase* GetBookCtrl();
+    wxBookCtrlBase* GetBookCtrl() const;
 
     /**
         Returns the inner sizer that contains the book control and button sizer.
     */
-    wxSizer* GetInnerSizer();
+    wxSizer* GetInnerSizer() const;
 
     /**
         Returns the sheet style. See SetSheetStyle() for
         permissable values.
     */
-    long GetSheetStyle();
+    long GetSheetStyle() const;
 
     /**
         Call this to lay out the dialog. On PocketPC, this does nothing, since the
         dialog will be shown
         full-screen, and the layout will be done when the dialog receives a size event.
     */
-    void LayoutDialog(int centreFlags=wxBOTH);
+    void LayoutDialog(int centreFlags = wxBOTH);
 
     /**
         Sets the book control used for the dialog. You will normally not need to use
@@ -145,45 +145,38 @@ public:
         You can customize the look and feel of the dialog by setting the sheet style.
         It is
         a bit list of the following values:
-        
-        
+
         wxPROPSHEET_DEFAULT
-        
-        
+
         Uses the default look and feel for the controller window,
         normally a notebook except on Smartphone where a choice control is used.
-        
+
         wxPROPSHEET_NOTEBOOK
-        
-        
+
         Uses a notebook for the controller window.
-        
+
         wxPROPSHEET_TOOLBOOK
-        
-        
+
         Uses a toolbook for the controller window.
-        
+
         wxPROPSHEET_CHOICEBOOK
-        
-        
+
         Uses a choicebook for the controller window.
-        
+
         wxPROPSHEET_LISTBOOK
-        
-        
+
         Uses a listbook for the controller window.
-        
+
         wxPROPSHEET_TREEBOOK
-        
-        
+
         Uses a treebook for the controller window.
-        
+
         wxPROPSHEET_SHRINKTOFIT
-        
-        
+
         Shrinks the dialog window to fit the currently selected page (common behaviour
         for
         property sheets on Mac OS X).
     */
     void SetSheetStyle(long style);
 };
+