Generalized wxScrolledWindow into wxScrolled<T> that can derive from

[wxWidgets.git] / interface / richtext / richtextformatdlg.h

diff --git a/interface/richtext/richtextformatdlg.h b/interface/richtext/richtextformatdlg.h
index 967e12d178e28ea8d1ab3d2d2ec8dbbe3f838f3b..c5d00abc7aad1bd5c863dd3b88a16902da889189 100644 (file)
--- a/interface/richtext/richtextformatdlg.h
+++ b/interface/richtext/richtextformatdlg.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        richtext/richtextformatdlg.h
-// Purpose:     documentation for wxRichTextFormattingDialogFactory class
+// Purpose:     interface of wxRichTextFormattingDialogFactory
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -55,17 +55,17 @@ public:
     /**
         Enumerate all available page identifiers.
     */
-    virtual int GetPageId(int i);
+    virtual int GetPageId(int i) const;
 
     /**
         Gets the number of available page identifiers.
     */
-    virtual int GetPageIdCount();
+    virtual int GetPageIdCount() const;
 
     /**
         Gets the image index for the given page identifier.
     */
-    virtual int GetPageImage(int id);
+    virtual int GetPageImage(int id) const;
 
     /**
         Set the property sheet style, called at the start of
@@ -81,6 +81,7 @@ public:
 };
 
 
+
 /**
     @class wxRichTextFormattingDialog
     @headerfile richtextformatdlg.h wx/richtext/richtextformatdlg.h
@@ -111,7 +112,7 @@ public:
     @endcode
 
     @library{wxrichtext}
-    @category{cmndlg}
+    @category{richtext}
 */
 class wxRichTextFormattingDialog : public wxPropertySheetDialog
 {
@@ -121,25 +122,19 @@ public:
         Constructors.
         
         @param flags
-        The pages to show.
-        
+            The pages to show.
         @param parent
-        The dialog's parent.
-        
+            The dialog's parent.
         @param id
-        The dialog's identifier.
-        
+            The dialog's identifier.
         @param title
-        The dialog's caption.
-        
+            The dialog's caption.
         @param pos
-        The dialog's position.
-        
+            The dialog's position.
         @param size
-        The dialog's size.
-        
+            The dialog's size.
         @param style
-        The dialog's window style.
+            The dialog's window style.
     */
     wxRichTextFormattingDialog(long flags, wxWindow* parent);
     const wxPoint& pos = wxDefaultPosition, const wxSize& sz = wxDefaultSize, long style = wxDEFAULT_DIALOG_STYLE)
@@ -174,7 +169,7 @@ public:
         Gets the attributes being edited.
     */
     const wxTextAttr GetAttributes();
-    wxTextAttr GetAttributes();
+    const wxTextAttr&  GetAttributes();
     //@}
 
     /**
@@ -201,7 +196,7 @@ public:
         Returns the image list associated with the dialog, used for example if showing
         the dialog as a toolbook.
     */
-    wxImageList* GetImageList();
+    wxImageList* GetImageList() const;
 
     /**
         Gets common attributes from the given range and calls SetAttributes. Attributes
@@ -213,12 +208,12 @@ public:
     /**
         Gets the associated style definition, if any.
     */
-    wxRichTextStyleDefinition* GetStyleDefinition();
+    wxRichTextStyleDefinition* GetStyleDefinition() const;
 
     /**
         Gets the associated style sheet, if any.
     */
-    wxRichTextStyleSheet* GetStyleSheet();
+    wxRichTextStyleSheet* GetStyleSheet() const;
 
     /**
         Sets the attributes to be edited.
@@ -238,20 +233,21 @@ public:
     void SetImageList(wxImageList* imageList);
 
     /**
-        Sets the attributes and optionally updates the display, if @e update is @true.
+        Sets the attributes and optionally updates the display, if @a update is @true.
     */
-    bool SetStyle(const wxTextAttr& style, bool update = @true);
+    bool SetStyle(const wxTextAttr& style, bool update = true);
 
     /**
-        Sets the style definition and optionally update the display, if @e update is @c
+        Sets the style definition and optionally update the display, if @a update is @c
         @true.
     */
     bool SetStyleDefinition(const wxRichTextStyleDefinition& styleDef,
                             wxRichTextStyleSheet* sheet,
-                            bool update = @true);
+                            bool update = true);
 
     /**
         Updates the display.
     */
     bool UpdateDisplay();
 };
+