close the handle returned by OpenProcessToken() (fixes #10129)

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

diff --git a/interface/wx/window.h b/interface/wx/window.h
index bc0f7c33f5208c544f795138836f6d4776ddaf03..8f8a9d8364b5c7632fd39e93ca1a263bcac2f9cb 100644 (file)
--- a/interface/wx/window.h
+++ b/interface/wx/window.h
@@ -207,8 +207,9 @@ enum wxUpdateUI
            Under Windows, puts a query button on the caption. When pressed,
            Windows will go into a context-sensitive help mode and wxWidgets
            will send a wxEVT_HELP event if the user clicked on an application window.
            Under Windows, puts a query button on the caption. When pressed,
            Windows will go into a context-sensitive help mode and wxWidgets
            will send a wxEVT_HELP event if the user clicked on an application window.

-           This style cannot be used together with wxMAXIMIZE_BOX or wxMINIMIZE_BOX, so
-           these two styles are automatically turned of if this one is used.
+           This style cannot be used (because of the underlying native behaviour)
+           together with @c wxMAXIMIZE_BOX or @c wxMINIMIZE_BOX, so these two styles
+           are automatically turned off if this one is used.

     @style{wxWS_EX_PROCESS_IDLE}
            This window should always process idle events, even if the mode set
            by wxIdleEvent::SetMode is wxIDLE_PROCESS_SPECIFIED.
     @style{wxWS_EX_PROCESS_IDLE}
            This window should always process idle events, even if the mode set
            by wxIdleEvent::SetMode is wxIDLE_PROCESS_SPECIFIED.


@@ -600,7 +601,11 @@ public:
             If @true, the window is eligible for drop file events.
             If @false, the window will not accept drop file events.
 
             If @true, the window is eligible for drop file events.
             If @false, the window will not accept drop file events.
 

-        @remarks Windows only.
+        @remarks Windows only until version 2.8.9, available on all platforms
+                 since 2.8.10. Cannot be used together with SetDropTarget() on
+                 non-Windows platforms.
+
+        @see SetDropTarget()

     */
     virtual void DragAcceptFiles(bool accept);
 
     */
     virtual void DragAcceptFiles(bool accept);
 


@@ -1055,28 +1060,35 @@ 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.
+
+        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.
+
+        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.

 
         @param menu
 
         @param menu

-            The menu to show
+            The menu to show.

         @param pos
         @param pos

-            The position at which to show the menu in client coordinates
+            The position at which to show the menu in client coordinates.

 
 

-        @return The selected menu item id or wxID_NONE if none selected or an
-                 error occurred.
-    */
-    int GetPopupMenuSelectionFromUser(wxMenu& menu, const wxPoint& pos);
+        @return
+             The selected menu item id or @c wxID_NONE if none selected or an
+             error occurred.

 
 

-    /**
-        See the GetPopupMenuSelectionFromUser(wxMenu&, const wxPoint&) overload.
-        This overload differs only because it takes two integers for the
-        menu position instead of a wxPoint.
+        @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


@@ -1498,8 +1510,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
     */


@@ -1508,6 +1522,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();


@@ -1741,7 +1758,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()
     */


@@ -1976,8 +1995,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()
     */


@@ -2435,6 +2455,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.