Extend history api using the ie backend to include loading history items, and getting...

[wxWidgets.git] / interface / wx / rearrangectrl.h

diff --git a/interface/wx/rearrangectrl.h b/interface/wx/rearrangectrl.h
index 9160b3efa7426da6e8dc1b09882702497ebbc708..976fb505433b6132eb96630d5de1a2cf23b0bd12 100644 (file)
--- a/interface/wx/rearrangectrl.h
+++ b/interface/wx/rearrangectrl.h
@@ -5,7 +5,7 @@
 // Created:     2008-12-15
 // RCS-ID:      $Id$
 // Copyright:   (c) 2008 Vadim Zeitlin <vadim@wxwidgets.org>
 // Created:     2008-12-15
 // RCS-ID:      $Id$
 // Copyright:   (c) 2008 Vadim Zeitlin <vadim@wxwidgets.org>

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -42,6 +42,8 @@
     is to use wxRearrangeCtrl which combines it with two standard buttons to
     move the current item up or down.
 
     is to use wxRearrangeCtrl which combines it with two standard buttons to
     move the current item up or down.
 

+    @since 2.9.0
+

     @library{wxcore}
     @category{ctrl}
 */
     @library{wxcore}
     @category{ctrl}
 */


@@ -173,6 +175,8 @@ public:
     the "Up" and "Down" buttons to move the currently selected item up or down.
     It is used as the main part of a wxRearrangeDialog.
 
     the "Up" and "Down" buttons to move the currently selected item up or down.
     It is used as the main part of a wxRearrangeDialog.
 

+    @since 2.9.0
+

     @library{wxcore}
     @category{ctrl}
  */
     @library{wxcore}
     @category{ctrl}
  */


@@ -260,6 +264,8 @@ public:
         }
     @endcode
 
         }
     @endcode
 

+    @since 2.9.0
+

     @library{wxcore}
     @category{cmndlg}
  */
     @library{wxcore}
     @category{cmndlg}
  */


@@ -317,6 +323,52 @@ public:
                 const wxPoint& pos = wxDefaultPosition,
                 const wxString& name = wxRearrangeDialogNameStr);
 
                 const wxPoint& pos = wxDefaultPosition,
                 const wxString& name = wxRearrangeDialogNameStr);
 

+    /**
+        Customize the dialog by adding extra controls to it.
+
+        This function adds the given @a win to the dialog, putting it just
+        below the part occupied by wxRearrangeCtrl. It must be called after
+        creating the dialog and you will typically need to process the events
+        generated by the extra controls for them to do something useful.
+
+        For example:
+        @code
+            class MyRearrangeDialog : public wxRearrangeDialog
+            {
+            public:
+                MyRearrangeDialog(wxWindow *parent, ...)
+                    : wxRearrangeDialog(parent, ...)
+                {
+                    wxPanel *panel = new wxPanel(this);
+                    wxSizer *sizer = new wxBoxSizer(wxHORIZONTAL);
+                    sizer->Add(new wxStaticText(panel, wxID_ANY,
+                                                "Column width in pixels:"));
+                    sizer->Add(new wxTextCtrl(panel, wxID_ANY, ""));
+                    panel->SetSizer(sizer);
+                    AddExtraControls(panel);
+                }
+
+                ... code to update the text control with the currently selected
+                    item width and to react to its changes omitted ...
+            };
+        @endcode
+
+        See also the complete example of a custom rearrange dialog in the
+        dialogs sample.
+
+        @param win
+            The window containing the extra controls. It must have this dialog
+            as its parent.
+     */
+    void AddExtraControls(wxWindow *win);
+
+    /**
+        Return the list control used by the dialog.
+
+        @see wxRearrangeCtrl::GetList()
+     */
+    wxRearrangeList *GetList() const;
+

     /**
         Return the array describing the order of items after it was modified by
         the user.
     /**
         Return the array describing the order of items after it was modified by
         the user.