wxWidgets/interface/wx/iconloc.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

42 lines
1.3 KiB
Objective-C

/////////////////////////////////////////////////////////////////////////////
// Name: iconloc.h
// Purpose: interface of wxIconLocation
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxIconLocation
wxIconLocation is a tiny class describing the location of an (external, i.e.
not embedded into the application resources) icon. For most platforms it simply
contains the file name but under some others (notably Windows) the same file
may contain multiple icons and so this class also stores the index of the icon
inside the file.
In any case, its details should be of no interest to the application code and
most of them are not even documented here (on purpose) as it is only meant to
be used as an opaque class: the application may get the object of this class
from somewhere and the only reasonable thing to do with it later is to create
a wxIcon from it.
@library{wxbase}
@category{gdi}
@see wxIcon, wxFileType::GetIcon
*/
class wxIconLocation
{
public:
/**
Returns @true if the object is valid, i.e.\ was properly initialized, and
@false otherwise.
*/
bool IsOk() const;
void SetFileName(const wxString& filename);
const wxString& GetFileName() const;
};