12f5e1e78f
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54387 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
39 lines
1.3 KiB
Objective-C
39 lines
1.3 KiB
Objective-C
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: iconloc.h
|
|
// Purpose: interface of wxIconLocation
|
|
// Author: wxWidgets team
|
|
// RCS-ID: $Id$
|
|
// Licence: wxWindows license
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
/**
|
|
@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{FIXME}
|
|
|
|
@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;
|
|
};
|
|
|