interface/iconloc.h

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