1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2%% Name:        iconloc.tex
3%% Purpose:     wxIconLocation documentation
4%% Author:      Vadim Zeitlin
5%% Modified by:
6%% Created:     21.06.03
7%% RCS-ID:      $Id: iconloc.tex 32309 2005-02-22 15:09:56Z ABX $
8%% Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
9%% License:     wxWindows license
10%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11
12\section{\class{wxIconLocation}}\label{wxiconlocation}
13
14wxIconLocation is a tiny class describing the location of an (external, i.e.
15not embedded into the application resources) icon. For most platforms it simply
16contains the file name but under some others (notably Windows) the same file
17may contain multiple icons and so this class also stores the index of the icon
18inside the file.
19
20In any case, its details should be of no interest to the application code and
21most of them are not even documented here (on purpose) as it is only meant to
22be used as an opaque class: the application may get the object of this class
23from somewhere and the only reasonable thing to do with it later is to create
24a \helpref{wxIcon}{wxicon} from it.
25
26\wxheading{Derived from}
27
28None.
29
30\wxheading{Include files}
31
32<wx/iconloc.h>
33
34\wxheading{See also}
35
36\helpref{wxIcon}{wxicon}, \helpref{wxFileType::GetIcon}{wxfiletypegeticon}
37
38\latexignore{\rtfignore{\wxheading{Members}}}
39
40\membersection{wxIconLocation::IsOk}\label{wxiconlocationisok}
41
42\constfunc{bool}{IsOk}{\void}
43
44Returns {\tt true} if the object is valid, i.e. was properly initialized, and 
45{\tt false} otherwise.
46
47