Illustrate usage of wxDataViewListCtrl

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

diff --git a/interface/wx/window.h b/interface/wx/window.h
index 566bd781b2708c4090bc6d4c44f884ceb9172a5f..71b0f46344ca90590eae1f8c3559944bb647fb8e 100644 (file)
--- a/interface/wx/window.h
+++ b/interface/wx/window.h
@@ -657,7 +657,7 @@ public:
 
         @see FindWindow()
     */
 
         @see FindWindow()
     */

-    static wxWindow* FindWindowById(long id, wxWindow* parent = NULL);
+    static wxWindow* FindWindowById(long id, const wxWindow* parent = 0);

 
     /**
         Find a window by its label.
 
     /**
         Find a window by its label.


@@ -671,10 +671,10 @@ public:
         @see FindWindow()
     */
     static wxWindow* FindWindowByLabel(const wxString& label,
         @see FindWindow()
     */
     static wxWindow* FindWindowByLabel(const wxString& label,

-                                       wxWindow* parent = NULL);
+                                       const wxWindow* parent = 0);

 
     /**
 
     /**

-        Find a window by its name (as given in a window constructor or @b Create
+        Find a window by its name (as given in a window constructor or Create()

         function call).
 
         If @a parent is @NULL, the search will start from all top-level frames
         function call).
 
         If @a parent is @NULL, the search will start from all top-level frames


@@ -687,7 +687,7 @@ public:
         @see FindWindow()
     */
     static wxWindow* FindWindowByName(const wxString& name,
         @see FindWindow()
     */
     static wxWindow* FindWindowByName(const wxString& name,

-                                      wxWindow* parent = NULL);
+                                      const wxWindow* parent = 0);

 
     /**
         Sizes the window so that it fits around its subwindows.
 
     /**
         Sizes the window so that it fits around its subwindows.


@@ -1060,28 +1060,34 @@ public:
     */
     wxWindow* GetParent() const;
 
     */
     wxWindow* GetParent() const;
 

+    //@{

     /**
         This function shows a popup menu at the given position in this window and
     /**
         This function shows a popup menu at the given position in this window and

-        returns the selected id. It can be more convenient than the general purpose
-        PopupMenu() function for simple menus proposing a choice in a list of
-        strings to the user.
+        returns the selected id.

 
 

-        @param menu
-            The menu to show
-        @param pos
-            The position at which to show the menu in client coordinates
+        It can be more convenient than the general purpose PopupMenu() function
+        for simple menus proposing a choice in a list of strings to the user.

 
 

-        @return The selected menu item id or wxID_NONE if none selected or an
-                 error occurred.
-    */
-    int GetPopupMenuSelectionFromUser(wxMenu& menu, const wxPoint& pos);
+        Notice that to avoid unexpected conflicts between the (usually
+        consecutive range of) ids used by the menu passed to this function and
+        the existing EVT_UPDATE_UI() handlers, this function temporarily
+        disables UI updates for the window, so you need to manually disable
+        (or toggle or ...) any items which should be disabled in the menu
+        before showing it.

 
 

-    /**
-        See the GetPopupMenuSelectionFromUser(wxMenu&, const wxPoint&) overload.
-        This overload differs only because it takes two integers for the
-        menu position instead of a wxPoint.
+        The parameter @a menu is the menu to show.
+        The parameter @a pos (or the parameters @a x and @a y) is the
+        position at which to show the menu in client coordinates.
+
+        @return
+             The selected menu item id or @c wxID_NONE if none selected or an
+             error occurred.
+
+        @since 2.9.0

     */
     */

+    int GetPopupMenuSelectionFromUser(wxMenu& menu, const wxPoint& pos);

     int GetPopupMenuSelectionFromUser(wxMenu& menu, int x, int y);
     int GetPopupMenuSelectionFromUser(wxMenu& menu, int x, int y);

+    //@}

 
     /**
         This gets the position of the window in pixels, relative to the parent window
 
     /**
         This gets the position of the window in pixels, relative to the parent window


@@ -1271,11 +1277,14 @@ public:
     */
     virtual wxSize GetWindowBorderSize() const;
 
     */
     virtual wxSize GetWindowBorderSize() const;
 

+    //@{

     /**
     /**

-        Gets the window style that was passed to the constructor or @b Create
-        method. @b GetWindowStyle() is another name for the same function.
+        Gets the window style that was passed to the constructor or Create()
+        method. GetWindowStyle() is another name for the same function.

     */
     virtual long GetWindowStyleFlag() const;
     */
     virtual long GetWindowStyleFlag() const;

+    long GetWindowStyle() const;
+    //@}

 
     /**
         Returns the value previously passed to SetWindowVariant().
 
     /**
         Returns the value previously passed to SetWindowVariant().


@@ -1503,8 +1512,10 @@ public:
         Invokes the constraint-based layout algorithm or the sizer-based algorithm
         for this window.
 
         Invokes the constraint-based layout algorithm or the sizer-based algorithm
         for this window.
 

-        See SetAutoLayout(): when auto layout is on, this function gets called automatically
-        when the window is resized.
+        This function does not get called automatically when the window is resized
+        because lots of windows deriving from wxWindow does not need this functionality.
+        If you want to have Layout() called automatically, you should derive
+        from wxPanel (see wxPanel::Layout).

 
         @see @ref overview_windowsizing
     */
 
         @see @ref overview_windowsizing
     */


@@ -1513,6 +1524,9 @@ public:
     /**
         Lowers the window to the bottom of the window hierarchy (Z-order).
 
     /**
         Lowers the window to the bottom of the window hierarchy (Z-order).
 

+        @remarks
+        This function only works for wxTopLevelWindow-derived classes.
+

         @see Raise()
     */
     virtual void Lower();
         @see Raise()
     */
     virtual void Lower();


@@ -1746,7 +1760,9 @@ public:
 
     /**
         Raises the window to the top of the window hierarchy (Z-order).
 
     /**
         Raises the window to the top of the window hierarchy (Z-order).

-        In current version of wxWidgets this works both for managed and child windows.
+
+        @remarks
+        This function only works for wxTopLevelWindow-derived classes.

 
         @see Lower()
     */
 
         @see Lower()
     */


@@ -1981,8 +1997,9 @@ public:
         updated when its size changes.
 
         @param autoLayout
         updated when its size changes.
 
         @param autoLayout

-            Set this to @true if you wish the Layout function to be
-            called automatically when the window is resized.
+            Set this to @true if you wish the Layout() function to be
+            called automatically when the window is resized
+            (really happens only if you derive from wxPanel or wxTopLevelWindow).

 
         @see SetConstraints()
     */
 
         @see SetConstraints()
     */


@@ -2353,7 +2370,10 @@ public:
         @param thumbSize
             The size of the thumb, or visible portion of the scrollbar, in scroll units.
         @param range
         @param thumbSize
             The size of the thumb, or visible portion of the scrollbar, in scroll units.
         @param range

-            The maximum position of the scrollbar.
+            The maximum position of the scrollbar. Value of -1 can be used to
+            ask for the scrollbar to be shown but in the disabled state: this
+            can be used to avoid removing the scrollbar even when it is not
+            needed (currently this is only implemented in wxMSW port).

         @param refresh
             @true to redraw the scrollbar, @false otherwise.
 
         @param refresh
             @true to redraw the scrollbar, @false otherwise.
 


@@ -2440,6 +2460,17 @@ public:
     virtual void SetSize(int width, int height);
     //@}
 
     virtual void SetSize(int width, int height);
     //@}
 

+    /**
+        Use of this function for windows which are not toplevel windows
+        (such as wxDialog or wxFrame) is discouraged.
+        Please use SetMinSize() and SetMaxSize() instead.
+
+        @see wxTopLevelWindow::SetSizeHints
+    */
+    void SetSizeHints( const wxSize& minSize,
+                       const wxSize& maxSize=wxDefaultSize,
+                       const wxSize& incSize=wxDefaultSize);
+

     /**
         Sets the window to have the given layout sizer.
         The window will then own the object, and will take care of its deletion.
     /**
         Sets the window to have the given layout sizer.
         The window will then own the object, and will take care of its deletion.


@@ -2524,11 +2555,7 @@ public:
     void SetVirtualSize(const wxSize& size);
     //@}
 
     void SetVirtualSize(const wxSize& size);
     //@}
 

-    /**
-        Identical to SetWindowStyleFlag().
-    */
-    void SetWindowStyle(long style);
-
+    //@{

     /**
         Sets the style of the window. Please note that some styles cannot be changed
         after the window creation and that Refresh() might need to be be called
     /**
         Sets the style of the window. Please note that some styles cannot be changed
         after the window creation and that Refresh() might need to be be called


@@ -2539,6 +2566,8 @@ public:
         @see GetWindowStyleFlag()
     */
     virtual void SetWindowStyleFlag(long style);
         @see GetWindowStyleFlag()
     */
     virtual void SetWindowStyleFlag(long style);

+    void SetWindowStyle(long style);
+    //@}

 
     /**
         This function can be called under all platforms but only does anything under
 
     /**
         This function can be called under all platforms but only does anything under


@@ -2794,7 +2823,7 @@ protected:
 // Global functions/macros
 // ============================================================================
 
 // Global functions/macros
 // ============================================================================
 

-/** @ingroup group_funcmacro_misc */
+/** @addtogroup group_funcmacro_misc */

 //@{
 
 /**
 //@{
 
 /**