Set TOOLKIT_LOWERCASE correctly for the various flavors of wxOSX

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

diff --git a/interface/wx/window.h b/interface/wx/window.h
index 98d7a1a34430069a67e14be21d230c82edba2c8e..bc0f7c33f5208c544f795138836f6d4776ddaf03 100644 (file)
--- a/interface/wx/window.h
+++ b/interface/wx/window.h
@@ -319,7 +319,7 @@ public:
 
         @remarks This function is currently only implemented under Mac/Carbon.
     */
 
         @remarks This function is currently only implemented under Mac/Carbon.
     */

-    virtual void AlwaysShowScrollbars(bool = true, bool = true);
+    virtual void AlwaysShowScrollbars(bool hflag = true, bool vflag = true);

 
     /**
         Sets the cached best size value.
 
     /**
         Sets the cached best size value.


@@ -745,12 +745,6 @@ public:
     */
     wxAccessible* GetAccessible();
 
     */
     wxAccessible* GetAccessible();
 

-    /**
-        @deprecated
-        This method is deprecated, use GetEffectiveMinSize() instead.
-    */
-    wxSize GetAdjustedBestSize() const;
-

     /**
         Returns the background colour of the window.
 
     /**
         Returns the background colour of the window.
 


@@ -839,16 +833,12 @@ public:
     //@{
     /**
         Returns the size of the window 'client area' in pixels.
     //@{
     /**
         Returns the size of the window 'client area' in pixels.

+

         The client area is the area which may be drawn on by the programmer,
         excluding title bar, border, scrollbars, etc.
         Note that if this window is a top-level one and it is currently minimized, the
         return size is empty (both width and height are 0).
 
         The client area is the area which may be drawn on by the programmer,
         excluding title bar, border, scrollbars, etc.
         Note that if this window is a top-level one and it is currently minimized, the
         return size is empty (both width and height are 0).
 

-        @param width
-            Receives the client width in pixels.
-        @param height
-            Receives the client height in pixels.
-

         @see GetSize(), GetVirtualSize()
     */
     void GetClientSize(int* width, int* height) const;
         @see GetSize(), GetVirtualSize()
     */
     void GetClientSize(int* width, int* height) const;


@@ -969,7 +959,7 @@ public:
         @param origin
             Help event origin, see also wxHelpEvent::GetOrigin.
     */
         @param origin
             Help event origin, see also wxHelpEvent::GetOrigin.
     */

-    virtual wxString GetHelpTextAtPoint(const wxPoint point,
+    virtual wxString GetHelpTextAtPoint(const wxPoint& point,

                                         wxHelpEvent::Origin origin) const;
 
     /**
                                         wxHelpEvent::Origin origin) const;
 
     /**


@@ -1255,7 +1245,12 @@ public:
     /**
         This gets the virtual size of the window in pixels.
         By default it returns the client size of the window, but after a call to
     /**
         This gets the virtual size of the window in pixels.
         By default it returns the client size of the window, but after a call to

-        SetVirtualSize() it will return that size.
+        SetVirtualSize() it will return the size set with that method.
+    */
+    wxSize GetVirtualSize() const;
+
+    /**
+        Like the other GetVirtualSize() overload but uses pointers instead.

 
         @param width
             Receives the window virtual width.
 
         @param width
             Receives the window virtual width.


@@ -1263,7 +1258,6 @@ public:
             Receives the window virtual height.
     */
     void GetVirtualSize(int* width, int* height) const;
             Receives the window virtual height.
     */
     void GetVirtualSize(int* width, int* height) const;

-    wxSize GetVirtualSize() const;

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


@@ -1441,9 +1435,9 @@ public:
         only redrawing those areas, which have been exposed.
     */
     bool IsExposed(int x, int y) const;
         only redrawing those areas, which have been exposed.
     */
     bool IsExposed(int x, int y) const;

-    const bool IsExposed(wxPoint amp;pt) const;
-    const bool IsExposed(int x, int y, int w, int h) const;
-    const bool IsExposed(wxRect amp;rect) const;
+    bool IsExposed(wxPoint& pt) const;
+    bool IsExposed(int x, int y, int w, int h) const;
+    bool IsExposed(wxRect& rect) const;

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


@@ -1688,14 +1682,10 @@ public:
         processed as usually. If the coordinates are not specified, current mouse
         cursor position is used.
 
         processed as usually. If the coordinates are not specified, current mouse
         cursor position is used.
 

-        @param menu
-            Menu to pop up.
-        @param pos
-            The position where the menu will appear.
-        @param x
-            Required x position for the menu to appear.
-        @param y
-            Required y position for the menu to appear.
+        @a menu is the menu to pop up.
+
+        The position where the menu will appear can be specified either as a
+        wxPoint @a pos or by two integers (@a x and @a y).

 
         @remarks Just before the menu is popped up, wxMenu::UpdateUI is called to
                  ensure that the menu items are in the correct state.
 
         @remarks Just before the menu is popped up, wxMenu::UpdateUI is called to
                  ensure that the menu items are in the correct state.


@@ -1813,8 +1803,8 @@ public:
 
         @see UnregisterHotKey()
     */
 
         @see UnregisterHotKey()
     */

-    bool RegisterHotKey(int hotkeyId, int modifiers,
-                        int virtualKeyCode);
+    virtual bool RegisterHotKey(int hotkeyId, int modifiers,
+                                int virtualKeyCode);

 
     /**
         Releases mouse input captured with CaptureMouse().
 
     /**
         Releases mouse input captured with CaptureMouse().


@@ -1863,7 +1853,6 @@ public:
     */
     virtual bool Reparent(wxWindow* newParent);
 
     */
     virtual bool Reparent(wxWindow* newParent);
 

-    //@{

     /**
         Converts from screen to client window coordinates.
 
     /**
         Converts from screen to client window coordinates.
 


@@ -1871,12 +1860,16 @@ public:
             Stores the screen x coordinate and receives the client x coordinate.
         @param y
             Stores the screen x coordinate and receives the client x coordinate.
             Stores the screen x coordinate and receives the client x coordinate.
         @param y
             Stores the screen x coordinate and receives the client x coordinate.

+    */
+    void ScreenToClient(int* x, int* y) const;
+
+    /**
+        Converts from screen to client window coordinates.
+

         @param pt
         @param pt

-            The screen position for the second form of the function.
+            The screen position.

     */
     */

-    virtual void ScreenToClient(int* x, int* y) const;
-    virtual wxPoint ScreenToClient(const wxPoint& pt) const;
-    //@}
+    wxPoint ScreenToClient(const wxPoint& pt) const;

 
     /**
         Scrolls the window by the given number of lines down (if @a lines is
 
     /**
         Scrolls the window by the given number of lines down (if @a lines is


@@ -2050,13 +2043,6 @@ public:
         than SetSize(), since the application need not worry about what dimensions
         the border or title bar have when trying to fit the window around panel
         items, for example.
         than SetSize(), since the application need not worry about what dimensions
         the border or title bar have when trying to fit the window around panel
         items, for example.

-
-        @param width
-            The required client area width.
-        @param height
-            The required client area height.
-        @param size
-            The required client size.

     */
     virtual void SetClientSize(int width, int height);
     virtual void SetClientSize(const wxSize& size);
     */
     virtual void SetClientSize(int width, int height);
     virtual void SetClientSize(const wxSize& size);


@@ -2670,7 +2656,7 @@ public:
 
         @see RegisterHotKey()
     */
 
         @see RegisterHotKey()
     */

-    bool UnregisterHotKey(int hotkeyId);
+    virtual bool UnregisterHotKey(int hotkeyId);

 
     /**
         Unreserve an ID or range of IDs that was reserved by NewControlId().
 
     /**
         Unreserve an ID or range of IDs that was reserved by NewControlId().