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

adjusted indentation with astyle; added Id keyword

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52383 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-08 14:43:31 +00:00
parent aa6ec1d787
commit 7c913512a4
269 changed files with 9052 additions and 9058 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
interface/artprov.h
View File

@@ -9,7 +9,7 @@
/**
@class wxArtProvider
@wxheader{artprov.h}
wxArtProvider class is used to customize the look of wxWidgets application.
When wxWidgets needs to display an icon or a bitmap (e.g. in the standard file
dialog), it does not use a hard-coded resource but asks wxArtProvider for it
@@ -20,15 +20,15 @@
wxArtProvider::CreateIconBundle methods
and register the provider with
wxArtProvider::Push:
@code
class MyProvider : public wxArtProvider
{
protected:
wxBitmap CreateBitmap(const wxArtID& id,
wxBitmap CreateBitmap(const wxArtID& id,
const wxArtClient& client,
const wxSize size)
// optionally override this one as well
wxIconBundle CreateIconBundle(const wxArtID& id,
const wxArtClient& client)
@@ -37,20 +37,20 @@
...
wxArtProvider::Push(new MyProvider);
@endcode
If you need bitmap images (of the same artwork) that should be displayed at
different sizes
you should probably consider overriding wxArtProvider::CreateIconBundle
you should probably consider overriding wxArtProvider::CreateIconBundle
and supplying icon bundles that contain different bitmap sizes.
There's another way of taking advantage of this class: you can use it in your
code and use
platform native icons as provided by wxArtProvider::GetBitmap or
platform native icons as provided by wxArtProvider::GetBitmap or
wxArtProvider::GetIcon (NB: this is not yet really
possible as of wxWidgets 2.3.3, the set of wxArtProvider bitmaps is too
small).
small).
wxArtProvider::~wxArtProvider
wxArtProvider::CreateBitmap
wxArtProvider::CreateIconBundle
@@ -62,16 +62,16 @@
wxArtProvider::Pop
wxArtProvider::Push
wxArtProvider::Remove
Identifying art resources
Every bitmap and icon bundle are known to wxArtProvider under an unique ID that
is used when
requesting a resource from it. The ID is represented by wxArtID type and can
have one of these predefined values (you can see bitmaps represented by these
constants in the artprov sample):
wxART_ERROR
wxART_QUESTION
wxART_WARNING
@@ -120,14 +120,14 @@
wxART_FLOPPY
wxART_CDROM
wxART_REMOVABLE
Additionally, any string recognized by custom art providers registered using
Additionally, any string recognized by custom art providers registered using
wxArtProvider::Push may be used.
@library{wxcore}
@category{FIXME}
@seealso
See the artprov sample for an example of wxArtProvider usage.
*/
@@ -142,7 +142,7 @@ public:
/**
Client is the entity that calls wxArtProvider's GetBitmap or GetIcon
function. It is represented by wxClientID type and can have one of these
function. It is represented by wxClientID type and can have one of these
values:
wxART_TOOLBAR
@@ -160,7 +160,7 @@ public:
slightly different icons in menus and toolbars even though they represent the
same action (e.g. @c wx_ART_FILE_OPEN). Remember that this is really
only a hint for wxArtProvider -- it is common that
GetBitmap()
GetBitmap()
returns identical bitmap for different @e client values!
@sa See the artprov sample for an example of wxArtProvider usage.
@@ -173,14 +173,14 @@ public:
therefore not necessary to optimize CreateBitmap() for speed (e.g. you may
create wxBitmap objects from XPMs here).
@param id
@param id
wxArtID unique identifier of the bitmap.
@param client
@param client
wxArtClient identifier of the client (i.e. who is asking for the bitmap).
This only servers as a hint.
@param size
@param size
Preferred size of the bitmap. The function may return a bitmap of different
dimensions, it will be automatically rescaled to meet client's request.
@@ -205,13 +205,13 @@ public:
/**
Query registered providers for bitmap with given ID.
@param id
@param id
wxArtID unique identifier of the bitmap.
@param client
@param client
wxArtClient identifier of the client (i.e. who is asking for the bitmap).
@param size
@param size
Size of the returned bitmap or wxDefaultSize if size doesn't matter.
@returns The bitmap if one of registered providers recognizes the ID or
@@ -223,27 +223,27 @@ public:
//@{
/**
Returns a suitable size hint for the given @e wxArtClient. If
@e platform_default is @true, return a size based on the current platform,
Returns a suitable size hint for the given @e wxArtClient. If
@e platform_default is @true, return a size based on the current platform,
otherwise return the size from the topmost wxArtProvider. @e wxDefaultSize may
be
be
returned if the client doesn't have a specified size, like wxART_OTHER for
example.
*/
static wxIcon GetIcon(const wxArtID& id,
const wxArtClient& client = wxART_OTHER,
const wxSize& size = wxDefaultSize);
static wxSize GetSizeHint(const wxArtClient& client,
bool platform_default = @false);
static wxSize GetSizeHint(const wxArtClient& client,
bool platform_default = @false);
//@}
/**
Query registered providers for icon bundle with given ID.
@param id
@param id
wxArtID unique identifier of the icon bundle.
@param client
@param client
wxArtClient identifier of the client (i.e. who is asking for the icon bundle).
@returns The icon bundle if one of registered providers recognizes the ID
@@ -308,7 +308,7 @@ public:
wxART_CDROM
wxART_REMOVABLE
Additionally, any string recognized by custom art providers registered using
Additionally, any string recognized by custom art providers registered using
Push() may be used.
*/
@@ -335,7 +335,7 @@ public:
static void Push(wxArtProvider* provider);
/**
Remove a provider from the stack if it is on it. The provider is not
Remove a provider from the stack if it is on it. The provider is not
deleted, unlike when using Delete().
*/
static bool Remove(wxArtProvider* provider);