/***************************************************************************
 *                          Zanoza Modeler v2.x                            *
 *      This is unpublished propietary source code of Zanoza Software.     *
 *      The copyright notice does not evidence any actual or intended      *
 *                    publication of such source code.                     *
 *                                                                         *
 *                   Copyright (c) 2002 Zanoza Software.                   *
 *                                                                         *
 *                        All rights reserved.                             *
 ***************************************************************************
 *--------------------------------------------------------------------------
 * @author:   Oleg Melashenko
 *--------------------------------------------------------------------------
 * @purpose:  Declaration of the class IUserDefinedOptions
 *   Extension interface can be available on different classes.
 *   It extends class with an ability to allow user store and set
 *   custom options on an object. For example, it's supported
 *   by scene objects and by materials.
 *--------------------------------------------------------------------------
 * @created: 27 октября 2003 г. 11:57:00
 */

#if !defined(IUserDefinedOptions_h_included)
#define IUserDefinedOptions_h_included
//forward declaration of this class might require
namespace core
{ namespace ui
  { namespace controls
    { class IUserDefinedOptions; }; }; };
#include <zmodeler.h>
#include <core/ui/controls/uiControls.h>

namespace core
{
  namespace ui
  {
    namespace controls
    {
      
      class IUserDefinedOptions : public ZUnknown
      {
      public:
        virtual long getOptionsCount(void)=0;
        virtual ZRESULT deleteOption(long nIndex)=0;
        virtual ZRESULT addOption(ZString strName, eOptionControlType type, ZString strValue, LPCTSTR pszDescription=NULL, long* pIndex=NULL)=0;
        virtual ZRESULT addSelectionOption(ZString strName, ZStringSeq& seqSelections, LPCTSTR strDefault, LPCTSTR pszDescription=NULL, long* pIndex=NULL)=0;
        virtual ZRESULT getOptionType(long nIndex, eOptionControlType& type)=0;
        virtual ZRESULT setOptionType(long nIndex, eOptionControlType type)=0;
        virtual ZRESULT setOptionName(long nIndex, LPCTSTR pszName)=0;
        virtual ZRESULT getOptionName(long nIndex, ZString& strName)=0;
        virtual ZRESULT setOptionHint(long nIndex, LPCTSTR pszHint)=0;
        virtual ZRESULT getOptionHint(long nIndex, ZString& strHint)=0;
        virtual ZRESULT getOptionSelections(long nIndex, ZStringSeq& seqSelections)=0;
        virtual ZRESULT getOptionValue(long nIndex, ZString& strValue)=0;
        virtual ZRESULT setOptionValue(long nIndex, LPCTSTR strValue)=0;
        virtual ZRESULT getOptionValueByName(LPCTSTR pszName, ZString& strValue)=0;
      
      };//class IUserDefinedOptions
    };//controls
  };//ui
};//core

#endif
