Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

make sure all wxDefault* and all wxNull* global instances are documented

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53047 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-04-06 15:28:55 +00:00
parent a7507230d1
commit 6587411805
9 changed files with 108 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
interface/colour.h
View File

@@ -164,7 +164,7 @@ public:
/**
FIXME
An empty colour.
*/
wxColour wxNullColour;

18
interface/cursor.h
View File

@@ -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
*/

11
interface/datetime.h
View File

@@ -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;
/**

46
interface/font.h
View File

@@ -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

87
interface/gdicmn.h
View File

@@ -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:
//@{
/**
Create a point.
double x
double y
Members of the @b wxRealPoint object.
*/
wxRealPoint();
/**
Initializes the point with the given coordinates.
*/
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;

11
interface/icon.h
View File

@@ -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;

4
interface/iconbndl.h
View File

@@ -18,7 +18,7 @@
@category{FIXME}
@stdobjects
::wxNullIconBundle,
::wxNullIconBundle
*/
class wxIconBundle : public wxGDIObject
{
@@ -82,7 +82,7 @@ public:
/**
FIXME
An empty wxIconBundle.
*/
wxIconBundle wxNullIconBundle;

10
interface/image.h
View File

@@ -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;
// ============================================================================

8
interface/palette.h
View File

@@ -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;