/***************************************************************************
* Copyright ?2007 TWAIN Working Group:  
*   Adobe Systems Incorporated, AnyDoc Software Inc., Eastman Kodak Company, 
*   Fujitsu Computer Products of America, JFL Peripheral Solutions Inc., 
*   Ricoh Corporation, and Xerox Corporation.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*     * Redistributions of source code must retain the above copyright
*       notice, this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*     * Neither the name of the TWAIN Working Group nor the
*       names of its contributors may be used to endorse or promote products
*       derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY TWAIN Working Group ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL TWAIN Working Group BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
***************************************************************************/

/**
* @file TWAINContainerInt.h
* Int Container class for negotiating capabilities.
* @author TWAIN Working Group
* @date April 2007
*/


#ifndef __CTWAINCONTAINERINT_H__
#define __CTWAINCONTAINERINT_H__

#include "TWAINContainer.h"

  /**
  * Return the Int Value of the index into an enumeration of Ints  
  * @param[in] pCap The enumeration to retreive the value
  * @param[in] index the index into the enumeration to retrieve the value.
  * @return the Int value at index into pCap
  */
int GetIndexIntValue(pTW_ENUMERATION pCap, TW_UINT32 index);

/**
* This class can be used for any Integer based TWAIN container. 
* All values are stored internally as 1/1000th of an inch. They are converted
* as necessary when TWAIN containers are created. Any direct access will require
* the caller to do their own conversion. 
*/
class CTWAINContainerInt : public CTWAINContainer
{
  friend class CTWAIN_UI;
public:
  /**
  * Constructor.  
  * @param[in] _unCapID Capability ID
  * @param[in] _unItemType TWAIN Type TWTY_xxxx being stored.
  * @param[in] _unGetType TWON_xxxx container
  * @param[in] _nSupportedQueries the supported querie types TWQC_xxxx
  */
  CTWAINContainerInt(const TW_UINT16 _unCapID, 
                     const TW_UINT16 _unItemType, 
                     const TW_UINT16 _unGetType, 
                     const TW_INT32  _nSupportedQueries = TWQC_ALL,
                     const TW_UINT16 _unGetCurrentType = TWON_ONEVALUE,
                     const TW_UINT16 _unGetDefaultType = TWON_ONEVALUE);
  virtual ~CTWAINContainerInt();

  virtual TW_HANDLE GetContainer(const TW_UINT16 _unMsg);
  virtual TW_INT16 Set(pTW_CAPABILITY _pCap, TW_INT16 &Condition);
  virtual bool Reset();

  /**
  * Try to add a value for container.  The first value added to a capabiltiy is set as the default and current value.
  * @param[in] _nAdd the value to be added.
  * @param[in] _bDefault if true explisitly sets this value to be the default and current.  
  * @return true if success.
  */
  bool Add(int _nAdd, bool _bDefault = false);

  /**
  * Try to set the current value for container.
  * The value must already be part of the container.
  * @param[in] _nCurr the value to be set as current.
  * @return true if success.
  */
  bool SetCurrent(int _nCurr);

  /**
  * Return the default value through _nVal if set.
  * @param[out] _nVal set the default value on return.
  * @return true if success.
  */
  bool GetDefault(int &_nVal);

  /**
  * Return the current value through _nVal if set.
  * @param[out] _nVal set the current value on return.
  * @return true if success.
  */
  bool GetCurrent(int &_nVal);

  /**
  * Return a vector of supported values.
  * @return supported values.
  */
  const IntVector &GetSupported();
  
  /**
  * Return the current value from the container.
  * @param[in] _pVal pointer to TW_ONEVALUE container of 
  * @return the value converted to int.
  */
  int getValue(const pTW_ONEVALUE _pVal);

  /**
  * Return the weather or not the value is supported by this capability.
  * @param[in] _nVal the value to check to see if it is supported
  * @return true is the _nVal is supported.
  */
  bool isValueSupported(const int _nVal) {return -1 != getIndexForValue(_nVal);}

  /**
  * Return the index in vector list for value.
  * @param[in] _flVal value to search for.
  * @return the index of value, or -1 if does not exist.
  */
  int getIndexForValue(const int _nVal);

protected:
  /**
  * Check to see if type is valid.
  * @param[in] _unTWType type to check
  * @return true if valid
  */
  bool isValidType(const TW_UINT16 _unTWType);

  /**
  * This is a utility function used to help create the TWAIN container.
  * @param[in] _pItemList container to fill up.
  * @param[in] _unNumItems number of fields to fill in.
  * @param[in] _unItemType type of item in container.
  */
  void fillValues(void* _pItemList, const TW_UINT32 _unNumItems, const TW_UINT16 _unItemType);

  IntVector m_listInts;                          /**< vector of valid container values. */
  IntVector m_listIntsDefault;                   /**< vector of valid container default values. */
};

#endif // __CTWAINCONTAINERINT_H__