From 658741180583e3219bdd26b83a798cf3c8a59df7 Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Sun, 6 Apr 2008 15:28:55 +0000 Subject: [PATCH] make sure all wxDefault* and all wxNull* global instances are documented git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53047 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/colour.h | 2 +- interface/cursor.h | 18 ++-------- interface/datetime.h | 11 ++++++ interface/font.h | 46 ++++++++++++++++++++++-- interface/gdicmn.h | 85 +++++++++++++++++--------------------------- interface/icon.h | 11 ++---- interface/iconbndl.h | 4 +-- interface/image.h | 10 ++++-- interface/palette.h | 8 +++-- 9 files changed, 107 insertions(+), 88 deletions(-) diff --git a/interface/colour.h b/interface/colour.h index e7ffbb84b9..86b430e66f 100644 --- a/interface/colour.h +++ b/interface/colour.h @@ -164,7 +164,7 @@ public: /** - FIXME + An empty colour. */ wxColour wxNullColour; diff --git a/interface/cursor.h b/interface/cursor.h index b4fca7a39b..e812b591b9 100644 --- a/interface/cursor.h +++ b/interface/cursor.h @@ -28,8 +28,7 @@ @category{gdi} @stdobjects - ::Objects:, ::wxNullCursor, ::Pointers:, ::wxSTANDARD_CURSOR, - ::wxHOURGLASS_CURSOR, ::wxCROSS_CURSOR, + ::wxNullCursor, ::wxSTANDARD_CURSOR, ::wxHOURGLASS_CURSOR, ::wxCROSS_CURSOR @see wxBitmap, wxIcon, wxWindow::SetCursor, ::wxSetCursor */ @@ -461,24 +460,11 @@ public: wxCursor operator =(const wxCursor& cursor); }; - -/** - FIXME -*/ -wxCursor Objects: -; - /** - FIXME + An empty wxCursor. */ wxCursor wxNullCursor; -/** - FIXME -*/ -wxCursor Pointers: -; - /** FIXME */ diff --git a/interface/datetime.h b/interface/datetime.h index a7a7af8749..c388f0b0b8 100644 --- a/interface/datetime.h +++ b/interface/datetime.h @@ -15,6 +15,9 @@ @library{wxbase} @category{data} + @stdobjects + ::wxDefaultDateTime + @see @ref overview_wxdatetimeoverview "Date classes overview", wxTimeSpan, wxDateSpan, wxCalendarCtrl */ @@ -1152,6 +1155,14 @@ public: wxDateTime operator(const struct tm& tm); }; +/** + Global instance of an empty wxDateTime object. + + @todo wouldn't be better to rename it wxNullDateTime as for the rest of wx global objects + which are initialized to an empty value? +*/ +wxDateTime wxDefaultDateTime; + /** diff --git a/interface/font.h b/interface/font.h index bcbe16bd90..a3eeaba9fe 100644 --- a/interface/font.h +++ b/interface/font.h @@ -29,8 +29,7 @@ @category{gdi} @stdobjects - ::Objects:, ::wxNullFont, ::Pointers:, ::wxNORMAL_FONT, ::wxSMALL_FONT, - ::wxITALIC_FONT, ::wxSWISS_FONT, + ::wxNullFont, ::wxNORMAL_FONT, ::wxSMALL_FONT, ::wxITALIC_FONT, ::wxSWISS_FONT @see @ref overview_wxfontoverview, wxDC::SetFont, wxDC::DrawText, wxDC::GetTextExtent, wxFontDialog, wxSystemSettings @@ -652,7 +651,7 @@ public: /** - FIXME + An empty wxFont. */ wxFont wxNullFont; @@ -677,6 +676,47 @@ wxFont wxITALIC_FONT; wxFont wxSWISS_FONT; +/** + @class wxFontList + @wxheader{gdicmn.h} + + A font list is a list containing all fonts which have been created. There + is only one instance of this class: @b wxTheFontList. Use this object to search + for a previously created font of the desired type and create it if not already + found. + In some windowing systems, the font may be a scarce resource, so it is best to + reuse old resources if possible. When an application finishes, all fonts will + be + deleted and their resources freed, eliminating the possibility of 'memory + leaks'. + + @library{wxcore} + @category{gdi} + + @see wxFont +*/ +class wxFontList : public wxList +{ +public: + /** + Constructor. The application should not construct its own font list: + use the object pointer @b wxTheFontList. + */ + wxFontList(); + + /** + Finds a font of the given specification, or creates one and adds it to the + list. See the @ref wxFont::ctor "wxFont constructor" for + details of the arguments. + */ + wxFont* FindOrCreateFont(int point_size, int family, int style, + int weight, + bool underline = false, + const wxString& facename = NULL, + wxFontEncoding encoding = wxFONTENCODING_DEFAULT); +}; + + // ============================================================================ // Global functions/macros diff --git a/interface/gdicmn.h b/interface/gdicmn.h index fb7f166798..724de72b84 100644 --- a/interface/gdicmn.h +++ b/interface/gdicmn.h @@ -8,7 +8,9 @@ /** - Bitmap flags. + Bitmap type flags. + + See wxBitmap and wxImage classes. */ enum wxBitmapType { @@ -50,6 +52,8 @@ enum wxBitmapType /** Standard cursors. + + See wxCursor. */ enum wxStockCursor { @@ -98,6 +102,7 @@ enum wxStockCursor @wxheader{gdicmn.h} A @b wxRealPoint is a useful data structure for graphics operations. + It contains floating point @e x and @e y members. See also wxPoint for an integer version. @@ -109,16 +114,22 @@ enum wxStockCursor class wxRealPoint { public: - //@{ + wxRealPoint(); + /** - Create a point. - double x - double y - Members of the @b wxRealPoint object. + Initializes the point with the given coordinates. */ - wxRealPoint(); wxRealPoint(double x, double y); - //@} + + /** + X coordinate of this point. + */ + double x; + + /** + Y coordinate of this point. + */ + double y; }; @@ -423,6 +434,9 @@ public: @library{wxcore} @category{data} + @stdobjects + ::wxDefaultPosition + @see wxRealPoint */ class wxPoint @@ -468,6 +482,10 @@ public: */ }; +/** + Global istance of a wxPoint initialized with values -1;-1. +*/ +wxPoint wxDefaultPosition; /** @@ -524,49 +542,6 @@ public: }; - -/** - @class wxFontList - @wxheader{gdicmn.h} - - A font list is a list containing all fonts which have been created. There - is only one instance of this class: @b wxTheFontList. Use this object to search - for a previously created font of the desired type and create it if not already - found. - In some windowing systems, the font may be a scarce resource, so it is best to - reuse old resources if possible. When an application finishes, all fonts will - be - deleted and their resources freed, eliminating the possibility of 'memory - leaks'. - - @library{wxcore} - @category{gdi} - - @see wxFont -*/ -class wxFontList : public wxList -{ -public: - /** - Constructor. The application should not construct its own font list: - use the object pointer @b wxTheFontList. - */ - wxFontList(); - - /** - Finds a font of the given specification, or creates one and adds it to the - list. See the @ref wxFont::ctor "wxFont constructor" for - details of the arguments. - */ - wxFont* FindOrCreateFont(int point_size, int family, int style, - int weight, - bool underline = false, - const wxString& facename = NULL, - wxFontEncoding encoding = wxFONTENCODING_DEFAULT); -}; - - - /** @class wxSize @wxheader{gdicmn.h} @@ -582,10 +557,12 @@ public: named @c width and @c height since it makes much more sense for sizes. - @library{wxcore} @category{data} + @stdobjects + ::wxDefaultSize + @see wxPoint, wxRealPoint */ class wxSize @@ -715,6 +692,10 @@ public: void SetWidth(int width); }; +/** + Global instance of a wxSize object initialized with values -1;-1. +*/ +wxSize wxDefaultSize; diff --git a/interface/icon.h b/interface/icon.h index 9b2d4282f2..877215fa52 100644 --- a/interface/icon.h +++ b/interface/icon.h @@ -25,7 +25,7 @@ @category{gdi} @stdobjects - ::Objects:, ::wxNullIcon, + ::wxNullIcon @see @ref overview_wxbitmapoverview "Bitmap and icon overview", @ref overview_supportedbitmapformats "supported bitmap file formats", wxDC::DrawIcon, wxCursor @@ -313,15 +313,8 @@ public: wxIcon operator =(const wxIcon& icon); }; - -/** - FIXME -*/ -wxIcon Objects: -; - /** - FIXME + An empty wxIcon. */ wxIcon wxNullIcon; diff --git a/interface/iconbndl.h b/interface/iconbndl.h index 1ac83d47c5..5fd493b68d 100644 --- a/interface/iconbndl.h +++ b/interface/iconbndl.h @@ -18,7 +18,7 @@ @category{FIXME} @stdobjects - ::wxNullIconBundle, + ::wxNullIconBundle */ class wxIconBundle : public wxGDIObject { @@ -82,7 +82,7 @@ public: /** - FIXME + An empty wxIconBundle. */ wxIconBundle wxNullIconBundle; diff --git a/interface/image.h b/interface/image.h index 65cfa7571b..20c057734e 100644 --- a/interface/image.h +++ b/interface/image.h @@ -155,12 +155,14 @@ public: be drawn in a device context, using wxDC::DrawBitmap. One colour value of the image may be used as a mask colour which will lead to - the automatic - creation of a wxMask object associated to the bitmap object. + the automatic creation of a wxMask object associated to the bitmap object. @library{wxcore} @category{gdi} + @stdobjects + ::wxNullImage + @see wxBitmap, wxInitAllImageHandlers() */ class wxImage : public wxObject @@ -1461,6 +1463,10 @@ public: wxImage operator =(const wxImage& image); }; +/** + An empty wxImage. +*/ +wxImage wxNullImage; // ============================================================================ diff --git a/interface/palette.h b/interface/palette.h index 6a5663e169..28707a3a62 100644 --- a/interface/palette.h +++ b/interface/palette.h @@ -39,12 +39,14 @@ public: Default constructor. */ wxPalette(); + /** Copy constructor, uses @ref overview_refcount. */ wxPalette(const wxPalette& palette); + /** - Creates a palette from arrays of size @e n, one for each red, blue or + Creates a palette from arrays of size @a n, one for each red, blue or green component. @param palette @@ -72,7 +74,7 @@ public: ~wxPalette(); /** - Creates a palette from arrays of size @e n, one for each red, blue or + Creates a palette from arrays of size @a n, one for each red, blue or green component. @param n @@ -147,7 +149,7 @@ public: /** - FIXME + An empty palette. */ wxPalette wxNullPalette; -- 2.45.2