imagelst.h

Go to the documentation of this file.

/****************************************************************************
 * \file mgui/imagelst.h
 * \brief MGUI::IMAGELIST class definitions
 *
 * \if NODOC
 * $Id: imagelst.h_v 1.11 2004/07/29 15:11:48 mju Exp $
 *
 * $Log: imagelst.h_v $
 * Revision 1.11  2004/07/29 15:11:48  mju
 * Add op= for X.
 * Make X methods non-inline.
 *
 * Revision 1.10  2003/10/03 19:58:19  linux32build!build
 * Doxygen
 *
 * Revision 1.9  2003/09/15 13:49:32  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.8  2003/07/25 22:22:55  dwilliss
 * Added an AddIcon method that takes a background color
 *
 * Revision 1.7  2002/10/09 15:53:29  mju
 * Moved to 'mgui' folder.
 *
 * Revision 1.6  2002/08/13 21:01:28  mju
 * Use mi32 instead of miwin.
 *
 * Revision 1.5  2002/03/15 23:31:32  dwilliss
 * When copying an image list, increment refcount of all icons (X only)
 *
 * Revision 1.4  2002/03/15 20:48:07  dwilliss
 * Gave a copy constructor for X
 *
 * Revision 1.3  2002/02/14 15:08:08  mju
 * Add comments.
 *
 * Revision 1.2  2002/02/06 22:22:09  dwilliss
 * Use ICONIDs which are portable between X and Windows
 *
 * Revision 1.1  2002/02/05 21:08:29  dwilliss
 * Initial revision
 * \endif
****************************************************************************/

#ifndef INC_MGUI_IMAGELST_H
#define INC_MGUI_IMAGELST_H


#ifndef MGUI_IMAGELST_H
#define MGUI_IMAGELST_H


#ifndef INC_MI32_STDDEFNS_H
#include <mi32/stddefns.h>
#endif

#ifdef WIN32_MFC
#ifndef INC_MI32_STDAFX_H
#include <mi32/stdafx.h>
#endif
#endif   //!< MFC


#ifdef X_NATIVE
#ifndef INC_MI32_SIMPLEAR_H
#include <mi32/simplear.h>
#endif
#ifndef INC_MI32_MICON_H
#include <mi32/micon.h>
#endif
#endif   //!< X Native


enum ICONID;
struct COLOR;

namespace MGUI {


//! Image list for icons, bitmaps, etc.
class IMAGELIST 
#ifdef WIN32_MFC
   : public CImageList
#endif
   {
   public:

      //! Constructor.
      IMAGELIST (
         ) { }

   #ifdef X_NATIVE
      // Copy constructor.
      IMAGELIST (
         const IMAGELIST& rhs
         );
   #endif

      //! Destructor.
      ~IMAGELIST (); 

   #ifdef X_NATIVE
      // Assignment.
      IMAGELIST& operator= (
         const IMAGELIST& rhs
         );
   #endif

      //! Add an icon given an ICONID.
      //! @return Icon index in the image list or < 0 if an error
      int AddIcon (
         ICONID id,                       //!< Icon ID
         int size = 16                    //!< Icon size
         );

      //! Add an icon given an ICONID.
      //! @return Icon index in the image list or < 0 if an error
      int AddIcon (
         ICONID id,                       //!< Icon ID
         const COLOR& bgcolor,            //!< Color to use for background
         int size = 16                    //!< Icon size
         );

   #ifdef X_NATIVE
      //! Get MICON pointer for image list entry (X only).
      //! @return Icon pointer for use in other X functions.
      MICON GetIcon (
         int index
         ) const;
   #endif

   private:
   #ifndef GENERATING_DOXYGEN_OUTPUT

   #ifdef X_NATIVE
      SIMPLE_ARRAY<MICON> m_Icons;
      void AddRef ();
      void Free ();
   #endif
   #endif // GENERATING_DOXYGEN_OUTPUT
   };

} // End of MGUI namespace


#endif


#endif  // INC_MGUI_IMAGELST_H

---