IGeneralXMLPreferences.h

//========================================================================================
// 
// $File$
// 
// Owner: Ryan Gano
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// This interface is used for action components to update the state of their actions.
// It is NOT a standard boss interface - it does not inherit from IPMUnknown!
// 
//========================================================================================

#ifndef __IGeneralXMLPreferences__
#define __IGeneralXMLPreferences__

#include "XMLID.h"

class IGeneralXMLPreferences : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IGENERALXMLPREFERENCES };
 
 typedef enum {
 kStoryLocation = 0, 
 kTableLocation, 
 kRowLocation, 
 kCellLocation, 
 kImageLocation,
 kTableHeaderLocation,
 kTableBodyLocation,
 kTableFooterLocation,
 kEndElementType
 } kElementType;

 virtual ErrorCode Set(IGeneralXMLPreferences *data) = 0;

 virtual void SetData(IGeneralXMLPreferences::kElementType which, const WideString &name, UID color) = 0;

 virtual void GetData(IGeneralXMLPreferences::kElementType which, WideString *name, UID *color) const = 0;

 virtual WideString GetName(IGeneralXMLPreferences::kElementType which) const = 0;

 virtual UID GetColor(IGeneralXMLPreferences::kElementType which) const = 0;

 virtual WideString GetDefaultName(IGeneralXMLPreferences::kElementType which) const = 0;

 virtual int32 GetDefaultColor(IGeneralXMLPreferences::kElementType which) const = 0;
 virtual bool16 operator==(const IGeneralXMLPreferences &o) = 0;
};

#endif // __IIGeneralXMLPreferences__