X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4c20f3d26bf2ae6e3af074f0f9fcdaefbd115028..9e9574fe45b176ee74bba8fad7574cf9906145d1:/interface/wx/gdicmn.h diff --git a/interface/wx/gdicmn.h b/interface/wx/gdicmn.h index ec06e76c6f..4cd2fd34e7 100644 --- a/interface/wx/gdicmn.h +++ b/interface/wx/gdicmn.h @@ -2,7 +2,6 @@ // Name: gdicmn.h // Purpose: interface of wxRealPoint // Author: wxWidgets team -// RCS-ID: $Id$ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -1154,6 +1153,24 @@ void wxSetCursor(const wxCursor& cursor); //@} +/** @addtogroup group_funcmacro_gdi */ +//@{ +/** + Returns the dimensions of the work area on the display. + + This is the same as wxGetClientDisplayRect() but allows to retrieve the + individual components instead of the entire rectangle. + + Any of the output pointers can be @NULL if the corresponding value is not + needed by the caller. + + @see wxDisplay + + @header{wx/gdicmn.h} +*/ +void wxClientDisplayRect(int* x, int* y, int* width, int* height); +//@} + /** @addtogroup group_funcmacro_gdi */ //@{ /** @@ -1162,9 +1179,10 @@ void wxSetCursor(const wxCursor& cursor); currently defaulting to the whole display until a way is found to provide this info for all window managers, etc. + @see wxDisplay + @header{wx/gdicmn.h} */ -void wxClientDisplayRect(int* x, int* y, int* width, int* height); wxRect wxGetClientDisplayRect(); //@} @@ -1178,6 +1196,8 @@ wxRect wxGetClientDisplayRect(); @header{wx/gdicmn.h} + @see wxDisplay + @since 2.9.0 */ wxSize wxGetDisplayPPI(); @@ -1188,12 +1208,25 @@ wxSize wxGetDisplayPPI(); /** Returns the display size in pixels. - For the version taking @a width and @a header arguments, either of them - can be @NULL if the caller is not interested in the returned value. + Either of output pointers can be @NULL if the caller is not interested in + the corresponding value. + + @see wxGetDisplaySize(), wxDisplay @header{wx/gdicmn.h} */ void wxDisplaySize(int* width, int* height); +//@} + +/** @addtogroup group_funcmacro_gdi */ +//@{ +/** + Returns the display size in pixels. + + @see wxDisplay + + @header{wx/gdicmn.h} +*/ wxSize wxGetDisplaySize(); //@} @@ -1202,14 +1235,25 @@ wxSize wxGetDisplaySize(); /** Returns the display size in millimeters. - For the version taking @a width and @a header arguments, either of them - can be @NULL if the caller is not interested in the returned value. + Either of output pointers can be @NULL if the caller is not interested in + the corresponding value. - @see wxGetDisplayPPI() + @see wxGetDisplaySizeMM(), wxDisplay @header{wx/gdicmn.h} */ void wxDisplaySizeMM(int* width, int* height); +//@} + +/** @addtogroup group_funcmacro_gdi */ +//@{ +/** + Returns the display size in millimeters. + + @see wxDisplay + + @header{wx/gdicmn.h} +*/ wxSize wxGetDisplaySizeMM(); //@}