/**
- FIXME
+ An empty colour.
*/
wxColour wxNullColour;
@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
*/
wxCursor operator =(const wxCursor& cursor);
};
-
-/**
- FIXME
-*/
-wxCursor Objects:
-;
-
/**
- FIXME
+ An empty wxCursor.
*/
wxCursor wxNullCursor;
-/**
- FIXME
-*/
-wxCursor Pointers:
-;
-
/**
FIXME
*/
@library{wxbase}
@category{data}
+ @stdobjects
+ ::wxDefaultDateTime
+
@see @ref overview_wxdatetimeoverview "Date classes overview", wxTimeSpan,
wxDateSpan, wxCalendarCtrl
*/
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;
+
/**
@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
/**
- FIXME
+ An empty wxFont.
*/
wxFont wxNullFont;
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
/**
- Bitmap flags.
+ Bitmap type flags.
+
+ See wxBitmap and wxImage classes.
*/
enum wxBitmapType
{
/**
Standard cursors.
+
+ See wxCursor.
*/
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.
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;
};
@library{wxcore}
@category{data}
+ @stdobjects
+ ::wxDefaultPosition
+
@see wxRealPoint
*/
class wxPoint
*/
};
+/**
+ Global istance of a wxPoint initialized with values -1;-1.
+*/
+wxPoint wxDefaultPosition;
/**
};
-
-/**
- @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}
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
void SetWidth(int width);
};
+/**
+ Global instance of a wxSize object initialized with values -1;-1.
+*/
+wxSize wxDefaultSize;
@category{gdi}
@stdobjects
- ::Objects:, ::wxNullIcon,
+ ::wxNullIcon
@see @ref overview_wxbitmapoverview "Bitmap and icon overview", @ref
overview_supportedbitmapformats "supported bitmap file formats", wxDC::DrawIcon, wxCursor
wxIcon operator =(const wxIcon& icon);
};
-
-/**
- FIXME
-*/
-wxIcon Objects:
-;
-
/**
- FIXME
+ An empty wxIcon.
*/
wxIcon wxNullIcon;
@category{FIXME}
@stdobjects
- ::wxNullIconBundle,
+ ::wxNullIconBundle
*/
class wxIconBundle : public wxGDIObject
{
/**
- FIXME
+ An empty wxIconBundle.
*/
wxIconBundle wxNullIconBundle;
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
wxImage operator =(const wxImage& image);
};
+/**
+ An empty wxImage.
+*/
+wxImage wxNullImage;
// ============================================================================
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
~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
/**
- FIXME
+ An empty palette.
*/
wxPalette wxNullPalette;
projects / wxWidgets.git / commitdiff
