From 4d7b68d13298eda460096714565d5c2379c00cfb Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Sun, 6 Apr 2008 16:19:04 +0000 Subject: [PATCH] my revision of o-p interface headers git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53060 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/panel.h | 35 +++---- interface/pen.h | 36 ++++--- interface/pickerbase.h | 6 +- interface/platinfo.h | 220 +++++++++++++++++++---------------------- 4 files changed, 143 insertions(+), 154 deletions(-) diff --git a/interface/panel.h b/interface/panel.h index 46b64f19ed..6e6e8b3d68 100644 --- a/interface/panel.h +++ b/interface/panel.h @@ -16,14 +16,16 @@ for TAB traversal implemented by wxWidgets itself as well as native TAB traversal (such as for GTK 2.0). - @e Note: Tab traversal is implemented through an otherwise undocumented - intermediate wxControlContainer class from which any class can derive - in addition to the normal wxWindow base class. Please see @e wx/containr.h - and @e wx/panel.h to find out how this is achieved. + @note Tab traversal is implemented through an otherwise undocumented + intermediate wxControlContainer class from which any class can derive + in addition to the normal wxWindow base class. Please see @c wx/containr.h + and @c wx/panel.h to find out how this is achieved. - @e Note: if not all characters are being intercepted by your OnKeyDown or - OnChar handler, it may be because you are using the @c wxTAB_TRAVERSAL style, - which grabs some keypresses for use by child controls. + @note if not all characters are being intercepted by your OnKeyDown or + OnChar handler, it may be because you are using the @c wxTAB_TRAVERSAL style, + which grabs some keypresses for use by child controls. + + @remarks By default, a panel has the same colouring as a dialog. @library{wxbase} @category{miscwnd} @@ -38,6 +40,7 @@ public: Default constructor. */ wxPanel(); + /** Constructor. @@ -47,17 +50,14 @@ public: An identifier for the panel. @c wxID_ANY is taken to mean a default. @param pos The panel position. The value @c wxDefaultPosition indicates a default position, - chosen by - either the windowing system or wxWidgets, depending on platform. + chosen by either the windowing system or wxWidgets, depending on platform. @param size The panel size. The value @c wxDefaultSize indicates a default size, chosen by either the windowing system or wxWidgets, depending on platform. @param style The window style. See wxPanel. @param name - Used to associate a name with the window, - allowing the application user to set Motif resource values for - individual dialog boxes. + Window name. @see Create() */ @@ -115,9 +115,11 @@ public: void OnSysColourChanged(wxSysColourChangedEvent& event); /** - Overrides wxWindow::SetFocus(). This method - uses the (undocumented) mix-in class wxControlContainer which manages + Overrides wxWindow::SetFocus(). + + This method uses the (undocumented) mix-in class wxControlContainer which manages the focus and TAB logic for controls which usually have child controls. + In practice, if you call this method and the control has at least one child window, the focus will be given to the child window. @@ -126,9 +128,8 @@ public: virtual void SetFocus(); /** - In contrast to SetFocus() (see above) - this will set the focus to the panel even if there are child windows - in the panel. This is only rarely needed. + In contrast to SetFocus() (see above) this will set the focus to the panel + even if there are child windows in the panel. This is only rarely needed. */ virtual void SetFocusIgnoringChildren(); }; diff --git a/interface/pen.h b/interface/pen.h index 7192429d16..60a0d82213 100644 --- a/interface/pen.h +++ b/interface/pen.h @@ -104,9 +104,7 @@ enum wxPenCap lines and painting the outline of rectangles, ellipses, etc. It has a colour, a width and a style. - @remarks - - On a monochrome display, wxWidgets shows all non-white pens as black. + @note On a monochrome display, wxWidgets shows all non-white pens as black. Do not initialize objects on the stack before the program commences, since other required structures may not have been set up yet. @@ -118,7 +116,7 @@ enum wxPenCap be created. Therefore an application may wish to get a pointer to a pen by using the global list of pens ::wxThePenList, and calling the member function wxPenList::FindOrCreatePen(). - See the entry for wxPenList. + See wxPenList for more info. This class uses @ref overview_refcount "reference counting and copy-on-write" internally so that assignments between two instances of this class are very cheap. @@ -131,11 +129,9 @@ enum wxPenCap @category{gdi} @stdobjects - ::wxNullPen - - Predefined pointers: ::wxRED_PEN, ::wxCYAN_PEN, ::wxGREEN_PEN, - ::wxBLACK_PEN, ::wxWHITE_PEN, ::wxTRANSPARENT_PEN, ::wxBLACK_DASHED_PEN, - ::wxGREY_PEN, ::wxMEDIUM_GREY_PEN, ::wxLIGHT_GREY_PEN + ::wxNullPen, ::wxRED_PEN, ::wxCYAN_PEN, ::wxGREEN_PEN, ::wxBLACK_PEN, ::wxWHITE_PEN, + ::wxTRANSPARENT_PEN, ::wxBLACK_DASHED_PEN, ::wxGREY_PEN, ::wxMEDIUM_GREY_PEN, + ::wxLIGHT_GREY_PEN @see wxPenList, wxDC, wxDC::SetPen() */ @@ -327,6 +323,7 @@ public: /** Inequality operator. + See @ref overview_refcount_equality "reference-counted object comparison" for more info. */ @@ -339,6 +336,7 @@ public: /** Equality operator. + See @ref overview_refcount_equality "reference-counted object comparison" for more info. */ @@ -353,52 +351,52 @@ wxPen wxNullPen; /** Red pen. */ -wxPen wxRED_PEN; +wxPen* wxRED_PEN; /** Cyan pen. */ -wxPen wxCYAN_PEN; +wxPen* wxCYAN_PEN; /** Green pen. */ -wxPen wxGREEN_PEN; +wxPen* wxGREEN_PEN; /** Black pen. */ -wxPen wxBLACK_PEN; +wxPen* wxBLACK_PEN; /** White pen. */ -wxPen wxWHITE_PEN; +wxPen* wxWHITE_PEN; /** Transparent pen. */ -wxPen wxTRANSPARENT_PEN; +wxPen* wxTRANSPARENT_PEN; /** Black dashed pen. */ -wxPen wxBLACK_DASHED_PEN; +wxPen* wxBLACK_DASHED_PEN; /** Grey pen. */ -wxPen wxGREY_PEN; +wxPen* wxGREY_PEN; /** Medium-grey pen. */ -wxPen wxMEDIUM_GREY_PEN; +wxPen* wxMEDIUM_GREY_PEN; /** Light-grey pen. */ -wxPen wxLIGHT_GREY_PEN; +wxPen* wxLIGHT_GREY_PEN; diff --git a/interface/pickerbase.h b/interface/pickerbase.h index d5c5c32a59..8fca81bdd4 100644 --- a/interface/pickerbase.h +++ b/interface/pickerbase.h @@ -15,6 +15,7 @@ This class handles all positioning and sizing of the text control like a an horizontal wxBoxSizer would do, with the text control on the left of the picker button. + The proportion (see wxSizer documentation for more info about proportion values) of the picker control defaults to 1 when there isn't a text control associated (see @c wxPB_USE_TEXTCTRL style) and to 0 otherwise. @@ -99,7 +100,7 @@ public: /** Sets the proportion value of the picker. - Look at the overview of wxPickerBase for more details about this. + Look at the detailed description of wxPickerBase for more info. */ void SetPickerCtrlProportion(int prop); @@ -113,7 +114,8 @@ public: /** Sets the proportion value of the text control. - Look at the overview of wxPickerBase for more details about this. + Look at the detailed description of wxPickerBase for more info. + This function can be used only when HasTextCtrl() returns @true. */ void SetTextCtrlProportion(int prop); diff --git a/interface/platinfo.h b/interface/platinfo.h index ef63705453..ad557febef 100644 --- a/interface/platinfo.h +++ b/interface/platinfo.h @@ -6,6 +6,108 @@ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// + +/** + The following are the operating systems which are recognized by wxWidgets and + whose version can be detected at run-time. + + The values of the constants are chosen so that they can be combined as flags; + this allows to check for operating system families like e.g. wxOS_MAC and wxOS_UNIX. +*/ +enum wxOperatingSystemId +{ + wxOS_UNKNOWN = 0, //!< returned on error + + wxOS_MAC_OS = 1 << 0, //!< Apple Mac OS 8/9/X with Mac paths + wxOS_MAC_OSX_DARWIN = 1 << 1, //!< Apple Mac OS X with Unix paths + wxOS_MAC = wxOS_MAC_OS|wxOS_MAC_OSX_DARWIN, + + wxOS_WINDOWS_9X = 1 << 2, //!< Windows 9x family (95/98/ME) + wxOS_WINDOWS_NT = 1 << 3, //!< Windows NT family (NT/2000/XP) + wxOS_WINDOWS_MICRO = 1 << 4, //!< MicroWindows + wxOS_WINDOWS_CE = 1 << 5, //!< Windows CE (Window Mobile) + wxOS_WINDOWS = wxOS_WINDOWS_9X | + wxOS_WINDOWS_NT | + wxOS_WINDOWS_MICRO | + wxOS_WINDOWS_CE, + + wxOS_UNIX_LINUX = 1 << 6, //!< Linux + wxOS_UNIX_FREEBSD = 1 << 7, //!< FreeBSD + wxOS_UNIX_OPENBSD = 1 << 8, //!< OpenBSD + wxOS_UNIX_NETBSD = 1 << 9, //!< NetBSD + wxOS_UNIX_SOLARIS = 1 << 10, //!< SunOS + wxOS_UNIX_AIX = 1 << 11, //!< AIX + wxOS_UNIX_HPUX = 1 << 12, //!< HP/UX + wxOS_UNIX = wxOS_UNIX_LINUX | + wxOS_UNIX_FREEBSD | + wxOS_UNIX_OPENBSD | + wxOS_UNIX_NETBSD | + wxOS_UNIX_SOLARIS | + wxOS_UNIX_AIX | + wxOS_UNIX_HPUX, + + wxOS_DOS = 1 << 15, //!< Microsoft DOS + wxOS_OS2 = 1 << 16 //!< OS/2 +}; + +/** + The list of wxWidgets ports. + + Some of them can be used with more than a single (native) toolkit; + e.g. wxWinCE port sources can be used with smartphones, pocket PCs + and handheld devices SDKs. +*/ +enum wxPortId +{ + wxPORT_UNKNOWN = 0, //!< returned on error + + wxPORT_BASE = 1 << 0, //!< wxBase, no native toolkit used + + wxPORT_MSW = 1 << 1, //!< wxMSW, native toolkit is Windows API + wxPORT_MOTIF = 1 << 2, //!< wxMotif, using [Open]Motif or Lesstif + wxPORT_GTK = 1 << 3, //!< wxGTK, using GTK+ 1.x, 2.x, GPE or Maemo + wxPORT_MGL = 1 << 4, //!< wxMGL, using wxUniversal + wxPORT_X11 = 1 << 5, //!< wxX11, using wxUniversal + wxPORT_OS2 = 1 << 6, //!< wxOS2, using OS/2 Presentation Manager + wxPORT_MAC = 1 << 7, //!< wxMac, using Carbon or Classic Mac API + wxPORT_COCOA = 1 << 8, //!< wxCocoa, using Cocoa NextStep/Mac API + wxPORT_WINCE = 1 << 9, //!< wxWinCE, toolkit is WinCE SDK API + wxPORT_PALMOS = 1 << 10, //!< wxPalmOS, toolkit is PalmOS API + wxPORT_DFB = 1 << 11 //!< wxDFB, using wxUniversal +}; + + +/** + The architecture of the operating system + (regardless of the build environment of wxWidgets library + - see ::wxIsPlatform64bit documentation for more info). +*/ +enum wxArchitecture +{ + wxARCH_INVALID = -1, //!< returned on error + + wxARCH_32, //!< 32 bit + wxARCH_64, + + wxARCH_MAX +} + + +/** + The endian-ness of the machine. +*/ +enum wxEndianness +{ + wxENDIAN_INVALID = -1, //!< returned on error + + wxENDIAN_BIG, //!< 4321 + wxENDIAN_LITTLE, //!< 1234 + wxENDIAN_PDP, //!< 3412 + + wxENDIAN_MAX +} + + /** @class wxPlatformInfo @wxheader{platinfo.h} @@ -18,120 +120,7 @@ @category{misc} @see ::wxGetOsVersion(), wxIsPlatformLittleEndian(), wxIsPlatform64Bit(), - wxAppTraits - - Data structures: - - The following are the operating systems which are recognized by wxWidgets and - whose version can be detected at run-time. - The values of the constants are chosen so that they can be combined as flags; - this allows to check for operating system families like - e.g. wxOS_MAC and wxOS_UNIX. - - @code - - enum wxOperatingSystemId - { - wxOS_UNKNOWN = 0, // returned on error - - wxOS_MAC_OS = 1 << 0, // Apple Mac OS 8/9/X with Mac paths - wxOS_MAC_OSX_DARWIN = 1 << 1, // Apple Mac OS X with Unix paths - wxOS_MAC = wxOS_MAC_OS|wxOS_MAC_OSX_DARWIN, - - wxOS_WINDOWS_9X = 1 << 2, // Windows 9x family (95/98/ME) - wxOS_WINDOWS_NT = 1 << 3, // Windows NT family (NT/2000/XP) - wxOS_WINDOWS_MICRO = 1 << 4, // MicroWindows - wxOS_WINDOWS_CE = 1 << 5, // Windows CE (Window Mobile) - wxOS_WINDOWS = wxOS_WINDOWS_9X | - wxOS_WINDOWS_NT | - wxOS_WINDOWS_MICRO | - wxOS_WINDOWS_CE, - - wxOS_UNIX_LINUX = 1 << 6, // Linux - wxOS_UNIX_FREEBSD = 1 << 7, // FreeBSD - wxOS_UNIX_OPENBSD = 1 << 8, // OpenBSD - wxOS_UNIX_NETBSD = 1 << 9, // NetBSD - wxOS_UNIX_SOLARIS = 1 << 10, // SunOS - wxOS_UNIX_AIX = 1 << 11, // AIX - wxOS_UNIX_HPUX = 1 << 12, // HP/UX - wxOS_UNIX = wxOS_UNIX_LINUX | - wxOS_UNIX_FREEBSD | - wxOS_UNIX_OPENBSD | - wxOS_UNIX_NETBSD | - wxOS_UNIX_SOLARIS | - wxOS_UNIX_AIX | - wxOS_UNIX_HPUX, - - wxOS_DOS = 1 << 15, // Microsoft DOS - wxOS_OS2 = 1 << 16 // OS/2 - }; - - @endcode - - The list of wxWidgets ports. - Some of them can be used with more than a single (native) toolkit; - e.g. wxWinCE port sources can be used with smartphones, pocket PCs - and handheld devices SDKs. - - @code - - enum wxPortId - { - wxPORT_UNKNOWN = 0, // returned on error - - wxPORT_BASE = 1 << 0, // wxBase, no native toolkit used - - wxPORT_MSW = 1 << 1, // wxMSW, native toolkit is Windows API - wxPORT_MOTIF = 1 << 2, // wxMotif, using [Open]Motif or Lesstif - wxPORT_GTK = 1 << 3, // wxGTK, using GTK+ 1.x, 2.x, GPE or Maemo - wxPORT_MGL = 1 << 4, // wxMGL, using wxUniversal - wxPORT_X11 = 1 << 5, // wxX11, using wxUniversal - wxPORT_OS2 = 1 << 6, // wxOS2, using OS/2 Presentation Manager - wxPORT_MAC = 1 << 7, // wxMac, using Carbon or Classic Mac API - wxPORT_COCOA = 1 << 8, // wxCocoa, using Cocoa NextStep/Mac API - wxPORT_WINCE = 1 << 9, // wxWinCE, toolkit is WinCE SDK API - wxPORT_PALMOS = 1 << 10, // wxPalmOS, toolkit is PalmOS API - wxPORT_DFB = 1 << 11 // wxDFB, using wxUniversal - }; - - @endcode - - The architecture of the operating system - (regardless of the build environment of wxWidgets library - - see wxIsPlatform64bit documentation for more info). - - @code - - enum wxArchitecture - { - wxARCH_INVALID = -1, // returned on error - - wxARCH_32, // 32 bit - wxARCH_64, - - wxARCH_MAX - } - - @endcode - - The endian-ness of the machine. - - @code - - enum wxEndianness - { - wxENDIAN_INVALID = -1, // returned on error - - wxENDIAN_BIG, // 4321 - wxENDIAN_LITTLE, // 1234 - wxENDIAN_PDP, // 3412 - - wxENDIAN_MAX - } - - @endcode - - + wxAppTraits */ class wxPlatformInfo : public wxObject { @@ -314,8 +303,7 @@ public: The @a usingUniversal argument specifies whether the port is in its native or wxUniversal variant. - The returned string does not start with the "wx" prefix and is always lower - case. + The returned string does not start with the "wx" prefix and is always lower case. */ static wxString GetPortIdShortName(wxPortId port, bool usingUniversal) const;