| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: iconloc.h |
| 3 | // Purpose: interface of wxIconLocation |
| 4 | // Author: wxWidgets team |
| 5 | // RCS-ID: $Id$ |
| 6 | // Licence: wxWindows licence |
| 7 | ///////////////////////////////////////////////////////////////////////////// |
| 8 | |
| 9 | /** |
| 10 | @class wxIconLocation |
| 11 | |
| 12 | wxIconLocation is a tiny class describing the location of an (external, i.e. |
| 13 | not embedded into the application resources) icon. For most platforms it simply |
| 14 | contains the file name but under some others (notably Windows) the same file |
| 15 | may contain multiple icons and so this class also stores the index of the icon |
| 16 | inside the file. |
| 17 | |
| 18 | In any case, its details should be of no interest to the application code and |
| 19 | most of them are not even documented here (on purpose) as it is only meant to |
| 20 | be used as an opaque class: the application may get the object of this class |
| 21 | from somewhere and the only reasonable thing to do with it later is to create |
| 22 | a wxIcon from it. |
| 23 | |
| 24 | @library{wxbase} |
| 25 | @category{gdi} |
| 26 | |
| 27 | @see wxIcon, wxFileType::GetIcon |
| 28 | */ |
| 29 | class wxIconLocation |
| 30 | { |
| 31 | public: |
| 32 | /** |
| 33 | Returns @true if the object is valid, i.e. was properly initialized, and |
| 34 | @false otherwise. |
| 35 | */ |
| 36 | bool IsOk() const; |
| 37 | }; |
| 38 | |