interface/wx/iconloc.h

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