maxicon.h

Go to the documentation of this file.

 /**********************************************************************
 *<
   FILE: MaxIcon.h

   DESCRIPTION: Max Icon and Icon Table definitions

   CREATED BY: Scott Morrison

   HISTORY: Created 15 March, 2000,

 *>   Copyright (c) 2000, All Rights Reserved.
 **********************************************************************/

#pragma once

#include "object.h"
#include "iColorMan.h"
#include "strbasic.h"

class ICustButton;

class MaxIcon : public InterfaceServer {
public:
    CoreExport virtual ~MaxIcon();
    // Get the image list for the size of icons that the user has chose
    virtual HIMAGELIST GetDefaultImageList()  = 0;
    // Get the image list for small icons
    virtual HIMAGELIST GetSmallImageList()  = 0;
    // Get the image list for large icons
    virtual HIMAGELIST GetLargeImageList()  = 0;

    // Get the index into the image list for the small version of this
    // particular icon.
    virtual int GetSmallImageIndex(bool enabledVersion = true,
                                   COLORREF backgroundColor =
                                   GetCustSysColor( COLOR_BTNFACE) ) = 0;
    // Get the index into the image list for the large version of this
    // particular icon.
    virtual int GetLargeImageIndex(bool enabledVersion = true,
                                   COLORREF backgroundColor =
                                   GetCustSysColor( COLOR_BTNFACE) ) = 0;
    // Get the index into the image list for the default version of this
    // particular icon.
            int GetDefaultImageIndex(bool enabledVersion = true,
                                     COLORREF backgroundColor =
                                     GetCustSysColor( COLOR_BTNFACE) );

    // returns true if the icons has an alpha mask that needs to be blended
    // with the background color.
    virtual bool UsesAlphaMask() = 0;
};

// This implementation of MaxIcon is for the icon images that are stored
// as ".bmp" files in MAX's UI directory.  This is used by the macroScript
// facility in MAXSrcipt to specify icons.  See the documentation for
// "macroScript" for the exact meaning of the filename and index.

class MaxBmpFileIcon: public MaxIcon {
public:
    CoreExport ~MaxBmpFileIcon();
    CoreExport MaxBmpFileIcon(const MCHAR* pFilePrefix, int index);
    CoreExport MaxBmpFileIcon(SClass_ID sid, Class_ID cid);

    CoreExport HIMAGELIST GetDefaultImageList();
    CoreExport HIMAGELIST GetSmallImageList();
    CoreExport HIMAGELIST GetLargeImageList();

    CoreExport int GetSmallImageIndex(bool enabledVersion = true,
                                      COLORREF backgroundColor =
                                      GetCustSysColor( COLOR_BTNFACE) );
    CoreExport int GetLargeImageIndex(bool enabledVersion = true,
                                      COLORREF backgroundColor =
                                      GetCustSysColor( COLOR_BTNFACE) );

    CoreExport bool UsesAlphaMask();
    CoreExport MSTR& GetFilePrefix() { return mFilePrefix; }
    CoreExport int GetIndex() { return mIndex; }

    CoreExport void SetKeepColor() { mKeepColor = true; }

    CoreExport bool GetKeepColor() { return mKeepColor; }

private:
    int     mIndex;
    MSTR    mFilePrefix;
    bool    mKeepColor;
};

CoreExport HIMAGELIST GetIconManDefaultImageList();
CoreExport HIMAGELIST GetIconManSmallImageList();
CoreExport HIMAGELIST GetIconManLargeImageList();

CoreExport BOOL LoadMAXFileIcon(MCHAR* pFile, HIMAGELIST hImageList, ColorId color, BOOL disabled);