Improved documentation for wxPGProperty::DoSetAttribute()

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

diff --git a/interface/wx/window.h b/interface/wx/window.h
index f0d02c7558e5fea3c3e9a16faa431904589c1c14..ed15f4adb039c6fe16c3c92673fc206a3a0e6a5d 100644 (file)
--- a/interface/wx/window.h
+++ b/interface/wx/window.h
@@ -782,6 +782,11 @@ public:
         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).
 
         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).
 

+        @beginWxPerlOnly
+        In wxPerl this method takes no parameters and returns
+        a 2-element list (width, height).
+        @endWxPerlOnly
+

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


@@ -858,6 +863,11 @@ public:
         @param height
             Receives the window height.
 
         @param height
             Receives the window height.
 

+        @beginWxPerlOnly
+        In wxPerl this method is implemented as GetSizeWH() returning
+        a 2-element list (width, height).
+        @endWxPerlOnly
+

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


@@ -1197,6 +1207,11 @@ public:
         @param y
             Receives the y position of the window if non-@NULL.
 
         @param y
             Receives the y position of the window if non-@NULL.
 

+        @beginWxPerlOnly
+        In wxPerl this method is implemented as GetPositionXY() returning
+        a 2-element list (x, y).
+        @endWxPerlOnly
+

         @see GetScreenPosition()
     */
     void GetPosition(int* x, int* y) const;
         @see GetScreenPosition()
     */
     void GetPosition(int* x, int* y) const;


@@ -1305,6 +1320,11 @@ public:
             - ClientToScreen(point): Accepts and returns a wxPoint
             - ClientToScreenXY(x, y): Returns a 2-tuple, (x, y)
         @endWxPythonOnly
             - ClientToScreen(point): Accepts and returns a wxPoint
             - ClientToScreenXY(x, y): Returns a 2-tuple, (x, y)
         @endWxPythonOnly

+
+        @beginWxPerlOnly
+        In wxPerl this method returns a 2-element list instead of
+        modifying its parameters.
+        @endWxPerlOnly

     */
     void ClientToScreen(int* x, int* y) const;
 
     */
     void ClientToScreen(int* x, int* y) const;
 


@@ -1511,6 +1531,12 @@ public:
             Return value for external leading (optional).
         @param font
             Font to use instead of the current window font (optional).
             Return value for external leading (optional).
         @param font
             Font to use instead of the current window font (optional).

+
+        @beginWxPerlOnly
+        In wxPerl this method takes only the @a string and optionally
+        @a font parameters, and returns a 4-element list
+        (x, y, descent, externalLeading).
+        @endWxPerlOnly

     */
     void GetTextExtent(const wxString& string,
                         int* w, int* h,
     */
     void GetTextExtent(const wxString& string,
                         int* w, int* h,


@@ -1599,6 +1625,9 @@ public:
                  usually the themes represent the appearance chosen by the user
                  to be used for all applications on the system.
 
                  usually the themes represent the appearance chosen by the user
                  to be used for all applications on the system.
 

+        @return @true if the colour was really changed, @false if it was already set
+                to this colour and nothing was done.
+

         @see GetBackgroundColour(), SetForegroundColour(),
              GetForegroundColour(), ClearBackground(),
              Refresh(), wxEraseEvent
         @see GetBackgroundColour(), SetForegroundColour(),
              GetForegroundColour(), ClearBackground(),
              Refresh(), wxEraseEvent


@@ -1650,8 +1679,8 @@ public:
             Font to associate with this window, pass
             wxNullFont to reset to the default font.
 
             Font to associate with this window, pass
             wxNullFont to reset to the default font.
 

-        @return @true if the want was really changed, @false if it was already set
-                to this  font and so nothing was done.
+        @return @true if the font was really changed, @false if it was already set
+                to this font and nothing was done.

 
         @see GetFont(), InheritAttributes()
     */
 
         @see GetFont(), InheritAttributes()
     */


@@ -1670,6 +1699,9 @@ public:
                  interpretation according to the window class; it may be
                  the text colour or other colour, or it may not be used at all.
 
                  interpretation according to the window class; it may be
                  the text colour or other colour, or it may not be used at all.
 

+        @return @true if the colour was really changed, @false if it was already set
+                to this colour and nothing was done.
+

         @see GetForegroundColour(), SetBackgroundColour(),
              GetBackgroundColour(), ShouldInheritColours()
     */
         @see GetForegroundColour(), SetBackgroundColour(),
              GetBackgroundColour(), ShouldInheritColours()
     */


@@ -2811,8 +2843,10 @@ public:
     /**
         Moves the pointer to the given position on the window.
 
     /**
         Moves the pointer to the given position on the window.
 

-        @note This function is not supported under Mac because Apple Human
-              Interface Guidelines forbid moving the mouse cursor programmatically.
+        @note Apple Human Interface Guidelines forbid moving the mouse cursor
+              programmatically so you should avoid using this function in Mac
+              applications (and probably avoid using it under the other
+              platforms without good reason as well).

 
         @param x
             The new x position for the cursor.
 
         @param x
             The new x position for the cursor.


@@ -2859,6 +2893,10 @@ public:
         Returns the platform-specific handle of the physical window.
         Cast it to an appropriate handle, such as @b HWND for Windows,
         @b Widget for Motif, @b GtkWidget for GTK or @b WinHandle for PalmOS.
         Returns the platform-specific handle of the physical window.
         Cast it to an appropriate handle, such as @b HWND for Windows,
         @b Widget for Motif, @b GtkWidget for GTK or @b WinHandle for PalmOS.

+
+        @beginWxPerlOnly
+        This method will return an integer in wxPerl.
+        @endWxPerlOnly

     */
     virtual WXWidget GetHandle() const;
 
     */
     virtual WXWidget GetHandle() const;