Added documentation for wxItemContainer class; moved methods docs

[wxWidgets.git] / interface / htmllbox.h

diff --git a/interface/htmllbox.h b/interface/htmllbox.h
index 72e185f7b34543c7fe0748076d1f5b9412a647ab..8b487f1ec5f9da667a42710dbf9a42dcd4566dbb 100644 (file)
--- a/interface/htmllbox.h
+++ b/interface/htmllbox.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        htmllbox.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        htmllbox.h

-// Purpose:     documentation for wxHtmlListBox class
+// Purpose:     interface of wxHtmlListBox

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,19 +9,18 @@
 /**
     @class wxHtmlListBox
     @wxheader{htmllbox.h}
 /**
     @class wxHtmlListBox
     @wxheader{htmllbox.h}

-    
+

     wxHtmlListBox is an implementation of wxVListBox which
     shows HTML content in the listbox rows. This is still an abstract base class
     and you will need to derive your own class from it (see htlbox sample for the
     example) but you will only need to override a single
     wxHtmlListBox::OnGetItem function.
     wxHtmlListBox is an implementation of wxVListBox which
     shows HTML content in the listbox rows. This is still an abstract base class
     and you will need to derive your own class from it (see htlbox sample for the
     example) but you will only need to override a single
     wxHtmlListBox::OnGetItem function.

-    
+

     @library{wxhtml}
     @category{ctrl}
     @appearance{htmllistbox.png}
     @library{wxhtml}
     @category{ctrl}
     @appearance{htmllistbox.png}

-    
-    @seealso
-    wxSimpleHtmlListBox
+
+    @see wxSimpleHtmlListBox

 */
 class wxHtmlListBox : public wxVListBox
 {
 */
 class wxHtmlListBox : public wxVListBox
 {


@@ -36,7 +35,7 @@ public:
                   const wxSize& size = wxDefaultSize,
                   long style = 0,
                   const wxString& name = wxHtmlListBoxNameStr);
                   const wxSize& size = wxDefaultSize,
                   long style = 0,
                   const wxString& name = wxHtmlListBoxNameStr);

-        wxHtmlListBox();
+    wxHtmlListBox();

     //@}
 
     /**
     //@}
 
     /**


@@ -48,10 +47,8 @@ public:
         Creates the control and optionally sets the initial number of items in it
         (it may also be set or changed later with
         wxVListBox::SetItemCount).
         Creates the control and optionally sets the initial number of items in it
         (it may also be set or changed later with
         wxVListBox::SetItemCount).

-        

         There are no special styles defined for wxHtmlListBox, in particular the
         wxListBox styles (with the exception of @c wxLB_MULTIPLE) can not be used here.
         There are no special styles defined for wxHtmlListBox, in particular the
         wxListBox styles (with the exception of @c wxLB_MULTIPLE) can not be used here.

-        

         Returns @true on success or @false if the control couldn't be created
     */
     bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,
         Returns @true on success or @false if the control couldn't be created
     */
     bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,


@@ -68,42 +65,40 @@ public:
         wxFileSystem::ChangePathTo if you use
         relative paths for the images or other resources embedded in your HTML.
     */
         wxFileSystem::ChangePathTo if you use
         relative paths for the images or other resources embedded in your HTML.
     */

-    wxFileSystem GetFileSystem();
-        const wxFileSystem GetFileSystem();
+    wxFileSystem GetFileSystem() const;
+    const wxFileSystem GetFileSystem() const;

     //@}
 
     /**
         This virtual function may be overridden to change the appearance of the
         background of the selected cells in the same way as
         GetSelectedTextColour().
     //@}
 
     /**
         This virtual function may be overridden to change the appearance of the
         background of the selected cells in the same way as
         GetSelectedTextColour().

-        

         It should be rarely, if ever, used because
         wxVListBox::SetSelectionBackground allows to
         change the selection background for all cells at once and doing anything more
         fancy is probably going to look strangely.
         It should be rarely, if ever, used because
         wxVListBox::SetSelectionBackground allows to
         change the selection background for all cells at once and doing anything more
         fancy is probably going to look strangely.

-        
-        @sa GetSelectedTextColour()
+
+        @see GetSelectedTextColour()

     */
     */

-    wxColour GetSelectedTextBgColour(const wxColour& colBg);
+    wxColour GetSelectedTextBgColour(const wxColour& colBg) const;

 
     /**
         This virtual function may be overridden to customize the appearance of the
 
     /**
         This virtual function may be overridden to customize the appearance of the

-        selected cells. It is used to determine how the colour @e colFg is going to
+        selected cells. It is used to determine how the colour @a colFg is going to

         look inside selection. By default all original colours are completely ignored
         and the standard, system-dependent, selection colour is used but the program
         may wish to override this to achieve some custom appearance.
         look inside selection. By default all original colours are completely ignored
         and the standard, system-dependent, selection colour is used but the program
         may wish to override this to achieve some custom appearance.

-        
-        @sa GetSelectedTextBgColour(),
-              wxVListBox::SetSelectionBackground, wxSystemSettings::GetColour
+
+        @see GetSelectedTextBgColour(),
+             wxVListBox::SetSelectionBackground, wxSystemSettings::GetColour

     */
     */

-    wxColour GetSelectedTextColour(const wxColour& colFg);
+    wxColour GetSelectedTextColour(const wxColour& colFg) const;

 
     /**
         This method must be implemented in the derived class and should return
         the body (i.e. without @c html nor @c body tags) of the HTML fragment
         for the given item.
 
     /**
         This method must be implemented in the derived class and should return
         the body (i.e. without @c html nor @c body tags) of the HTML fragment
         for the given item.

-        
-        Note that this function should always return a text fragment for the @e n item
+        Note that this function should always return a text fragment for the @a n item

         which renders with the same height both when it is selected and when it's not:
         i.e. if you call, inside your OnGetItem() implementation, @c IsSelected(n) to
         make the items appear differently when they are selected, then you should make
         which renders with the same height both when it is selected and when it's not:
         i.e. if you call, inside your OnGetItem() implementation, @c IsSelected(n) to
         make the items appear differently when they are selected, then you should make


@@ -111,37 +106,37 @@ public:
         that the returned HTML fragment will render with the same height or else you'll
         see some artifacts when the user selects an item.
     */
         that the returned HTML fragment will render with the same height or else you'll
         see some artifacts when the user selects an item.
     */

-    wxString OnGetItem(size_t n);
+    wxString OnGetItem(size_t n) const;

 
     /**
         This function may be overridden to decorate HTML returned by
         OnGetItem().
     */
 
     /**
         This function may be overridden to decorate HTML returned by
         OnGetItem().
     */

-    wxString OnGetItemMarkup(size_t n);
+    wxString OnGetItemMarkup(size_t n) const;

 
     /**
         Called when the user clicks on hypertext link. Does nothing by default.
         Overloading this method is deprecated; intercept the event instead.
 
     /**
         Called when the user clicks on hypertext link. Does nothing by default.
         Overloading this method is deprecated; intercept the event instead.

-        
-        @param n 
-        Index of the item containing the link.
-        
-        @param link 
-        Description of the link.
-        
-        @sa See also wxHtmlLinkInfo.
+
+        @param n
+            Index of the item containing the link.
+        @param link
+            Description of the link.
+
+        @see See also wxHtmlLinkInfo.

     */
     virtual void OnLinkClicked(size_t n, const wxHtmlLinkInfo& link);
 };
 
 
     */
     virtual void OnLinkClicked(size_t n, const wxHtmlLinkInfo& link);
 };
 
 

+

 /**
     @class wxSimpleHtmlListBox
     @wxheader{htmllbox.h}
 /**
     @class wxSimpleHtmlListBox
     @wxheader{htmllbox.h}

-    
+

     wxSimpleHtmlListBox is an implementation of wxHtmlListBox which
     shows HTML content in the listbox rows.
     wxSimpleHtmlListBox is an implementation of wxHtmlListBox which
     shows HTML content in the listbox rows.

-    
+

     Unlike wxHtmlListBox, this is not an abstract class and thus it
     has the advantage that you can use it without deriving your own class from it.
     However, it also has the disadvantage that this is not a virtual control and
     Unlike wxHtmlListBox, this is not an abstract class and thus it
     has the advantage that you can use it without deriving your own class from it.
     However, it also has the disadvantage that this is not a virtual control and


@@ -149,7 +144,7 @@ public:
     well-suited for those cases where you need to show a huge number of items:
     every time you
     add/insert a string, it will be stored internally and thus will take memory.
     well-suited for those cases where you need to show a huge number of items:
     every time you
     add/insert a string, it will be stored internally and thus will take memory.

-    
+

     The interface exposed by wxSimpleHtmlListBox fully implements the
     wxControlWithItems interface, thus you should refer to
     wxControlWithItems's documentation for the API reference
     The interface exposed by wxSimpleHtmlListBox fully implements the
     wxControlWithItems interface, thus you should refer to
     wxControlWithItems's documentation for the API reference


@@ -158,34 +153,33 @@ public:
     @c protected in wxSimpleHtmlListBox's context so that you cannot call it
     directly,
     wxSimpleHtmlListBox will do it for you.
     @c protected in wxSimpleHtmlListBox's context so that you cannot call it
     directly,
     wxSimpleHtmlListBox will do it for you.

-    
+

     Note: in case you need to append a lot of items to the control at once, make
     sure to use the
     @ref wxControlWithItems::append "Append(const wxArrayString )" function.
     Note: in case you need to append a lot of items to the control at once, make
     sure to use the
     @ref wxControlWithItems::append "Append(const wxArrayString )" function.

-    
+

     Thus the only difference between a wxListBox and a wxSimpleHtmlListBox
     is that the latter stores strings which can contain HTML fragments (see the
     list of
     @ref overview_htmltagssupported "tags supported by wxHTML").
     Thus the only difference between a wxListBox and a wxSimpleHtmlListBox
     is that the latter stores strings which can contain HTML fragments (see the
     list of
     @ref overview_htmltagssupported "tags supported by wxHTML").

-    
+

     Note that the HTML strings you fetch to wxSimpleHtmlListBox should not contain
     Note that the HTML strings you fetch to wxSimpleHtmlListBox should not contain

-    the @c html 
+    the @c html

     or @c body tags.
     or @c body tags.

-    
+

     @beginStyleTable
     @beginStyleTable

-    @style{wxHLB_DEFAULT_STYLE}:
+    @style{wxHLB_DEFAULT_STYLE}

            The default style: wxBORDER_SUNKEN
            The default style: wxBORDER_SUNKEN

-    @style{wxHLB_MULTIPLE}:
+    @style{wxHLB_MULTIPLE}

            Multiple-selection list: the user can toggle multiple items on and
            off.
     @endStyleTable
            Multiple-selection list: the user can toggle multiple items on and
            off.
     @endStyleTable

-    
+

     @library{wxhtml}
     @category{ctrl}
     @appearance{simplehtmllistbox.png}
     @library{wxhtml}
     @category{ctrl}
     @appearance{simplehtmllistbox.png}

-    
-    @seealso
-    wxSimpleHtmlListBox::Create
+
+    @see wxSimpleHtmlListBox::Create

 */
 class wxSimpleHtmlListBox : public wxHtmlListBox
 {
 */
 class wxSimpleHtmlListBox : public wxHtmlListBox
 {


@@ -199,21 +193,21 @@ public:
                   const wxPoint& pos = wxDefaultPosition,
                   const wxSize& size = wxDefaultSize,
                   int n = 0,
                   const wxPoint& pos = wxDefaultPosition,
                   const wxSize& size = wxDefaultSize,
                   int n = 0,

-                  const wxString choices[] = @NULL,
+                  const wxString choices[] = NULL,
+                  long style = wxHLB_DEFAULT_STYLE,
+                  const wxValidator& validator = wxDefaultValidator,
+                  const wxString& name = "simpleHtmlListBox");
+    wxHtmlListBox(wxWindow* parent, wxWindowID id,
+                  const wxPoint& pos,
+                  const wxSize& size,
+                  const wxArrayString& choices,

                   long style = wxHLB_DEFAULT_STYLE,
                   const wxValidator& validator = wxDefaultValidator,
                   const wxString& name = "simpleHtmlListBox");
                   long style = wxHLB_DEFAULT_STYLE,
                   const wxValidator& validator = wxDefaultValidator,
                   const wxString& name = "simpleHtmlListBox");

-        wxHtmlListBox(wxWindow* parent, wxWindowID id,
-                      const wxPoint& pos,
-                      const wxSize& size,
-                      const wxArrayString& choices,
-                      long style = wxHLB_DEFAULT_STYLE,
-                      const wxValidator& validator = wxDefaultValidator,
-                      const wxString& name = "simpleHtmlListBox");
-        See also
-wxSimpleHtmlListBox::Create
-
- wxSimpleHtmlListBox();
+    See also
+    wxSimpleHtmlListBox::Create
+
+    wxSimpleHtmlListBox();

     //@}
 
     /**
     //@}
 
     /**


@@ -223,23 +217,24 @@ wxSimpleHtmlListBox::Create
 
     //@{
     /**
 
     //@{
     /**

-        Creates the HTML listbox for two-step construction. 
+        Creates the HTML listbox for two-step construction.

         See wxSimpleHtmlListBox() for further details.
     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 int n,
         See wxSimpleHtmlListBox() for further details.
     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 int n,

-                const wxString choices[] = @NULL,
+                const wxString choices[] = NULL,
+                long style = wxHLB_DEFAULT_STYLE,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = "simpleHtmlListBox");
+    bool Create(wxWindow* parent, wxWindowID id,
+                const wxPoint& pos,
+                const wxSize& size,
+                const wxArrayString& choices,

                 long style = wxHLB_DEFAULT_STYLE,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = "simpleHtmlListBox");
                 long style = wxHLB_DEFAULT_STYLE,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = "simpleHtmlListBox");

-        bool Create(wxWindow* parent, wxWindowID id,
-                    const wxPoint& pos,
-                    const wxSize& size,
-                    const wxArrayString& choices,
-                    long style = wxHLB_DEFAULT_STYLE,
-                    const wxValidator& validator = wxDefaultValidator,
-                    const wxString& name = "simpleHtmlListBox");

     //@}
 };
     //@}
 };

+