|
AQUAMARINE
@n BLACK
@n BLUE
@n BLUE VIOLET
@n BROWN
@n CADET BLUE
@n CORAL
@n CORNFLOWER BLUE
@n CYAN
@n DARK GREY
@n DARK GREEN
@n DARK OLIVE GREEN
@n DARK ORCHID
@n DARK SLATE BLUE
@n DARK SLATE GREY
@n DARK TURQUOISE
@n DIM GREY
|
FIREBRICK
@n FOREST GREEN
@n GOLD
@n GOLDENROD
@n GREY
@n GREEN
@n GREEN YELLOW
@n INDIAN RED
@n KHAKI
@n LIGHT BLUE
@n LIGHT GREY
@n LIGHT STEEL BLUE
@n LIME GREEN
@n MAGENTA
@n MAROON
@n MEDIUM AQUAMARINE
@n MEDIUM BLUE
|
MEDIUM FOREST GREEN
@n MEDIUM GOLDENROD
@n MEDIUM ORCHID
@n MEDIUM SEA GREEN
@n MEDIUM SLATE BLUE
@n MEDIUM SPRING GREEN
@n MEDIUM TURQUOISE
@n MEDIUM VIOLET RED
@n MIDNIGHT BLUE
@n NAVY
@n ORANGE
@n ORANGE RED
@n ORCHID
@n PALE GREEN
@n PINK
@n PLUM
@n PURPLE
|
RED
@n SALMON
@n SEA GREEN
@n SIENNA
@n SKY BLUE
@n SLATE BLUE
@n SPRING GREEN
@n STEEL BLUE
@n TAN
@n THISTLE
@n TURQUOISE
@n VIOLET
@n VIOLET RED
@n WHEAT
@n WHITE
@n YELLOW
@n YELLOW GREEN
|
@endTable
@library{wxcore}
@category{gdi}
@see wxColour
*/
class wxColourDatabase
{
public:
/**
Constructs the colour database. It will be initialized at the first
use.
*/
wxColourDatabase();
/**
Adds a colour to the database. If a colour with the same name already
exists, it is replaced.
*/
void AddColour(const wxString& colourName, const wxColour& colour);
/**
Finds a colour given the name. Returns an invalid colour object (that
is, wxColour::IsOk() will return @false) if the colour wasn't found in
the database.
*/
wxColour Find(const wxString& colourName) const;
/**
Finds a colour name given the colour. Returns an empty string if the
colour is not found in the database.
*/
wxString FindName(const wxColour& colour) const;
};
/**
Global instance of a wxColourDatabase.
*/
wxColourDatabase* wxTheColourDatabase;
/**
@class wxSize
A wxSize is a useful data structure for graphics operations.
It simply contains integer @e width and @e height members.
Note that the width and height stored inside a wxSize object may be negative
and that wxSize functions do not perform any check against negative values
(this is used to e.g. store the special -1 value in ::wxDefaultSize instance).
See also IsFullySpecified() and SetDefaults() for utility functions regarding
the special -1 value.
wxSize is used throughout wxWidgets as well as wxPoint which, although
almost equivalent to wxSize, has a different meaning: wxPoint represents a
position while wxSize represents the size.
@library{wxcore}
@category{data}
@stdobjects
::wxDefaultSize
@see wxPoint, wxRealPoint
*/
class wxSize
{
public:
/**
Initializes this size object with zero width and height.
*/
wxSize();
/**
Initializes this size object with the given @a width and @a height.
*/
wxSize(int width, int height);
//@{
/**
Decreases the size in both x and y directions.
@see IncBy()
*/
void DecBy(const wxPoint& pt);
void DecBy(const wxSize& size);
void DecBy(int dx, int dy);
void DecBy(int d);
//@}
/**
Decrements this object so that both of its dimensions are not greater
than the corresponding dimensions of the @a size.
@see IncTo()
*/
void DecTo(const wxSize& size);
/**
Decrements this object to be not bigger than the given size ignoring
non-specified components.
This is similar to DecTo() but doesn't do anything for x or y
component if the same component of @a size is not specified, i.e. set
to ::wxDefaultCoord.
@since 2.9.5
*/
void DecToIfSpecified(const wxSize& size);
/**
Gets the height member.
*/
int GetHeight() const;
/**
Gets the width member.
*/
int GetWidth() const;
//@{
/**
Increases the size in both x and y directions.
@see DecBy()
*/
void IncBy(const wxPoint& pt);
void IncBy(const wxSize& size);
void IncBy(int dx, int dy);
void IncBy(int d);
//@}
/**
Increments this object so that both of its dimensions are not less than
the corresponding dimensions of the @a size.
@see DecTo()
*/
void IncTo(const wxSize& size);
/**
Returns @true if neither of the size object components is equal to -1,
which is used as default for the size values in wxWidgets (hence the
predefined ::wxDefaultSize has both of its components equal to -1).
This method is typically used before calling SetDefaults().
*/
bool IsFullySpecified() const;
/**
Scales the dimensions of this object by the given factors. If you want
to scale both dimensions by the same factor you can also use
operator*=().
@return A reference to this object (so that you can concatenate other
operations in the same line).
*/
wxSize& Scale(float xscale, float yscale);
/**
Sets the width and height members.
*/
void Set(int width, int height);
/**
Combine this size object with another one replacing the default (i.e.
equal to -1) components of this object with those of the other. It is
typically used like this:
@code
if ( !size.IsFullySpecified() )
{
size.SetDefaults(GetDefaultSize());
}
@endcode
@see IsFullySpecified()
*/
void SetDefaults(const wxSize& sizeDefault);
/**
Sets the height.
*/
void SetHeight(int height);
/**
Sets the width.
*/
void SetWidth(int width);
/**
@name Miscellaneous operators
Note that these operators are documented as class members
(to make them easier to find) but, as their prototype shows,
they are implemented as global operators; note that this is
transparent to the user but it helps to understand why the
following functions are documented to take the wxSize they
operate on as an explicit argument.
*/
//@{
wxSize& operator=(const wxSize& sz);
bool operator ==(const wxSize& s1, const wxSize& s2);
bool operator !=(const wxSize& s1, const wxSize& s2);
wxSize operator +(const wxSize& s1, const wxSize& s2);
wxSize operator -(const wxSize& s1, const wxSize& s2);
wxSize& operator +=(const wxSize& sz);
wxSize& operator -=(const wxSize& sz);
wxSize operator /(const wxSize& sz, int factor);
wxSize operator *(const wxSize& sz, int factor);
wxSize operator *(int factor, const wxSize& sz);
wxSize& operator /=(int factor);
wxSize& operator *=(int factor);
//@}
};
/**
Global instance of a wxSize object initialized to (-1,-1).
*/
const wxSize wxDefaultSize;
// ============================================================================
// Global functions/macros
// ============================================================================
/** @addtogroup group_funcmacro_gdi */
//@{
/**
This macro loads a bitmap from either application resources (on the
platforms for which they exist, i.e. Windows and OS2) or from an XPM file.
This can help to avoid using @ifdef_ when creating bitmaps.
@see @ref overview_bitmap, wxICON()
@header{wx/gdicmn.h}
*/
#define wxBITMAP(bitmapName)
/**
Creates a bitmap from either application resources or embedded image data
in PNG format.
This macro is similar to wxBITMAP() but works with bitmap data in PNG
format and not BMP or XPM.
Under Windows the given @a bitmapName must be present in the application
resource file with the type @c RCDATA and refer to a PNG image. I.e. you
should have a definition similar to the following in your @c .rc file:
@code
mybitmap RCDATA "mybitmap.png"
@endcode
to be able to use @c wxBITMAP_PNG(mybitmap) in the code.
Under OS X the file with the specified name and "png" extension must be
present in the "Resources" subdirectory of the application bundle.
Under the other platforms, this is equivalent to wxBITMAP_PNG_FROM_DATA()
and so loads the image data from the array called @c bitmapName_png that
must exist. Notice that it @e must be an array and not a pointer as the
macro needs to be able to determine its size. Such an array can be produced
by a number of conversion programs. A very simple one is included in
wxWidgets distribution as @c misc/scripts/png2c.py.
Finally notice that you must register PNG image handler to be able to
load bitmaps from PNG data. This can be done either by calling
wxInitAllImageHandlers() which also registers all the other image formats
or including the necessary header:
@code
#include