Commented out appearance sections in docs temporarily until screenshots are added.

[wxWidgets.git] / interface / listctrl.h

diff --git a/interface/listctrl.h b/interface/listctrl.h
index 733608fb12366c9cf1eac3e360db49f2d747c80a..b750af1a557d63ca400d7e224be97b35f2e64bf9 100644 (file)
--- a/interface/listctrl.h
+++ b/interface/listctrl.h
@@ -44,47 +44,47 @@
     1.
 
     @beginStyleTable
     1.
 
     @beginStyleTable

-    @style{wxLC_LIST}:
+    @style{wxLC_LIST}

            Multicolumn list view, with optional small icons. Columns are
            computed automatically, i.e. you don't set columns as in
            wxLC_REPORT. In other words, the list wraps, unlike a wxListBox.
            Multicolumn list view, with optional small icons. Columns are
            computed automatically, i.e. you don't set columns as in
            wxLC_REPORT. In other words, the list wraps, unlike a wxListBox.

-    @style{wxLC_REPORT}:
+    @style{wxLC_REPORT}

            Single or multicolumn report view, with optional header.
            Single or multicolumn report view, with optional header.

-    @style{wxLC_VIRTUAL}:
+    @style{wxLC_VIRTUAL}

            The application provides items text on demand. May only be used
            with wxLC_REPORT.
            The application provides items text on demand. May only be used
            with wxLC_REPORT.

-    @style{wxLC_ICON}:
+    @style{wxLC_ICON}

            Large icon view, with optional labels.
            Large icon view, with optional labels.

-    @style{wxLC_SMALL_ICON}:
+    @style{wxLC_SMALL_ICON}

            Small icon view, with optional labels.
            Small icon view, with optional labels.

-    @style{wxLC_ALIGN_TOP}:
+    @style{wxLC_ALIGN_TOP}

            Icons align to the top. Win32 default, Win32 only.
            Icons align to the top. Win32 default, Win32 only.

-    @style{wxLC_ALIGN_LEFT}:
+    @style{wxLC_ALIGN_LEFT}

            Icons align to the left.
            Icons align to the left.

-    @style{wxLC_AUTOARRANGE}:
+    @style{wxLC_AUTOARRANGE}

            Icons arrange themselves. Win32 only.
            Icons arrange themselves. Win32 only.

-    @style{wxLC_EDIT_LABELS}:
+    @style{wxLC_EDIT_LABELS}

            Labels are editable: the application will be notified when editing
            starts.
            Labels are editable: the application will be notified when editing
            starts.

-    @style{wxLC_NO_HEADER}:
+    @style{wxLC_NO_HEADER}

            No header in report mode.
            No header in report mode.

-    @style{wxLC_SINGLE_SEL}:
+    @style{wxLC_SINGLE_SEL}

            Single selection (default is multiple).
            Single selection (default is multiple).

-    @style{wxLC_SORT_ASCENDING}:
+    @style{wxLC_SORT_ASCENDING}

            Sort in ascending order (must still supply a comparison callback in
            SortItems.
            Sort in ascending order (must still supply a comparison callback in
            SortItems.

-    @style{wxLC_SORT_DESCENDING}:
+    @style{wxLC_SORT_DESCENDING}

            Sort in descending order (must still supply a comparison callback
            in SortItems.
            Sort in descending order (must still supply a comparison callback
            in SortItems.

-    @style{wxLC_HRULES}:
+    @style{wxLC_HRULES}

            Draws light horizontal rules between rows in report mode.
            Draws light horizontal rules between rows in report mode.

-    @style{wxLC_VRULES}:
+    @style{wxLC_VRULES}

            Draws light vertical rules between columns in report mode.
     @endStyleTable
 
     @library{wxcore}
     @category{ctrl}
            Draws light vertical rules between columns in report mode.
     @endStyleTable
 
     @library{wxcore}
     @category{ctrl}

-    @appearance{listctrl.png}
+    <!-- @appearance{listctrl.png} -->

 
     @see @ref overview_wxlistctrloverview "wxListCtrl overview", wxListView,
     wxListBox, wxTreeCtrl, wxImageList, wxListEvent, wxListItem
 
     @see @ref overview_wxlistctrloverview "wxListCtrl overview", wxListView,
     wxListBox, wxTreeCtrl, wxImageList, wxListEvent, wxListItem


@@ -179,7 +179,7 @@ public:
 
     /**
         Deletes all items in the list control.
 
     /**
         Deletes all items in the list control.

-        @b NB: This function does @e not send the
+        @note This function does @e not send the

         @c wxEVT_COMMAND_LIST_DELETE_ITEM event because deleting many items
         from the control would be too slow then (unlike wxListCtrl::DeleteItem).
     */
         @c wxEVT_COMMAND_LIST_DELETE_ITEM event because deleting many items
         from the control would be too slow then (unlike wxListCtrl::DeleteItem).
     */


@@ -275,7 +275,7 @@ public:
     /**
         Returns the edit control being currently used to edit a label. Returns @NULL
         if no label is being edited.
     /**
         Returns the edit control being currently used to edit a label. Returns @NULL
         if no label is being edited.

-        @b NB: It is currently only implemented for wxMSW and the generic version,
+        @note It is currently only implemented for wxMSW and the generic version,

         not for the native Mac OS X version.
     */
     wxTextCtrl* GetEditControl() const;
         not for the native Mac OS X version.
     */
     wxTextCtrl* GetEditControl() const;


@@ -399,7 +399,7 @@ public:
 
         Searches for an item to the right of the specified item.
 
 
         Searches for an item to the right of the specified item.
 

-        @b NB: this parameter is only supported by wxMSW currently and ignored on
+        @note this parameter is only supported by wxMSW currently and ignored on

         other platforms.
         @a state can be a bitlist of the following:
 
         other platforms.
         @a state can be a bitlist of the following:
 


@@ -442,7 +442,7 @@ public:
         @a code can be one of @c wxLIST_RECT_BOUNDS,
         @c wxLIST_RECT_ICON or @c wxLIST_RECT_LABEL.
 
         @a code can be one of @c wxLIST_RECT_BOUNDS,
         @c wxLIST_RECT_ICON or @c wxLIST_RECT_LABEL.
 

-        @wxsince{2.7.0}
+        @since 2.7.0

     */
     bool GetSubItemRect(long item, long subItem, wxRect& rect,
                         int code = wxLIST_RECT_BOUNDS) const;
     */
     bool GetSubItemRect(long item, long subItem, wxRect& rect,
                         int code = wxLIST_RECT_BOUNDS) const;


@@ -628,7 +628,7 @@ public:
         @a dx specifies the number of pixels to scroll. If in list view mode,
         @a dx specifies the number of columns to scroll. @a dy always specifies
         the number of pixels to scroll vertically.
         @a dx specifies the number of pixels to scroll. If in list view mode,
         @a dx specifies the number of columns to scroll. @a dy always specifies
         the number of pixels to scroll vertically.

-        @b NB: This method is currently only implemented in the Windows version.
+        @note This method is currently only implemented in the Windows version.

     */
     bool ScrollList(int dx, int dy);
 
     */
     bool ScrollList(int dx, int dy);
 


@@ -875,7 +875,7 @@ The m_stateMask and m_state members take flags from the following:
         guaranteed to be large enough to be able to contain all integer types and
         pointers.
 
         guaranteed to be large enough to be able to contain all integer types and
         pointers.
 

-        @wxsince{2.8.4}
+        @since 2.8.4

     */
     bool SetItemPtrData(long item, wxUIntPtr data);
 
     */
     bool SetItemPtrData(long item, wxUIntPtr data);
 


@@ -951,7 +951,7 @@ public:
     /**
         Constructor.
     */
     /**
         Constructor.
     */

-    wxListEvent(WXTYPE commandType = 0, int id = 0);
+    wxListEvent(wxEventType commandType = 0, int id = 0);

 
     /**
         For @c EVT_LIST_CACHE_HINT event only: return the first item which the
 
     /**
         For @c EVT_LIST_CACHE_HINT event only: return the first item which the


@@ -1122,7 +1122,7 @@ public:
 
     @library{wxcore}
     @category{ctrl}
 
     @library{wxcore}
     @category{ctrl}

-    @appearance{listview.png}
+    <!-- @appearance{listview.png} -->

 
     @see wxListView::SetColumnImage
 */
 
     @see wxListView::SetColumnImage
 */