wxWidgets/interface/wx/withimages.h
Vadim Zeitlin 3f66f6a5b3 Remove all lines containing cvs/svn "$Id$" keyword.
This keyword is not expanded by Git which means it's not replaced with the
correct revision value in the releases made using git-based scripts and it's
confusing to have lines with unexpanded "$Id$" in the released files. As
expanding them with Git is not that simple (it could be done with git archive
and export-subst attribute) and there are not many benefits in having them in
the first place, just remove all these lines.

If nothing else, this will make an eventual transition to Git simpler.

Closes #14487.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@74602 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2013-07-26 16:02:46 +00:00

57 lines
1.4 KiB
C++

///////////////////////////////////////////////////////////////////////////////
// Name: withimages.h
// Purpose: Interface of wxWithImages class.
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
/**
A mixin class to be used with other classes that use a wxImageList.
*/
class wxWithImages
{
public:
enum
{
NO_IMAGE = -1
};
wxWithImages();
virtual ~wxWithImages();
/**
Sets the image list for the page control and takes ownership of the list.
@see wxImageList, SetImageList()
*/
void AssignImageList(wxImageList* imageList);
/**
Sets the image list to use. It does not take ownership of the image
list, you must delete it yourself.
@see wxImageList, AssignImageList()
*/
virtual void SetImageList(wxImageList* imageList);
/**
Returns the associated image list, may be NULL.
@see wxImageList, SetImageList()
*/
wxImageList* GetImageList() const;
protected:
/**
Return true if we have a valid image list.
*/
bool HasImageList() const;
/**
Return the image with the given index from the image list.
If there is no image list or if index == NO_IMAGE, silently returns
wxNullIcon.
*/
wxIcon GetImage(int iconIndex) const;
};