IConditionalTextFacade.h

//========================================================================================
// 
// $File$
// 
// Owner: Michele Stutzman
// 
// $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.
// 
//========================================================================================

#ifndef __ICONDITIONALTEXTFACADE__
#define __ICONDITIONALTEXTFACADE__

#include "ConditionalTextID.h"
#include "IConditionTag.h"
#include "IConditionalTextOptions.h"
#include "RangeData.h"
#include "Utils.h"

class IConditionTagList;
class IConditionTagSetList;
class IWorkspace;

namespace Facade
{
 class IConditionalTextFacade : public IPMUnknown
 {
 public:
 enum { kDefaultIID = IID_ICONDITIONALTEXTFACADE };

 virtual ErrorCode CreateCondition(IWorkspace* ws, 
 UID* newConditionUID = nil,
 const WideString& name = WideString(""), 
 UID colorUID = kInvalidUID, 
 IConditionTag::IndicatorMethod method = IConditionTag::kUnderline, 
 IConditionTag::UnderlineIndicatorAppearance appearance = IConditionTag::kSingleWavy,
 bool16 visibleState = kTrue) = 0;

 virtual ErrorCode DeleteConditions(const UIDList& conditionsToDelete, UID conditionToReplaceWith = kInvalidUID) = 0;

 virtual ErrorCode SetConditionName(const UIDRef& conditionRef, const WideString& name) = 0;

 virtual ErrorCode GetConditionName(const UIDRef& conditionRef, WideString& name) const = 0;

 virtual ErrorCode SetConditionColor(const UIDRef& conditionRef, UID colorUID) = 0;

 virtual ErrorCode GetConditionColor(const UIDRef& conditionRef, UID& colorUID) const = 0;

 virtual ErrorCode SetConditionMethod(const UIDRef& conditionRef, IConditionTag::IndicatorMethod newMethod) = 0;

 virtual ErrorCode GetConditionMethod(const UIDRef& conditionRef, IConditionTag::IndicatorMethod& method) const = 0;

 virtual ErrorCode SetConditionAppearance(const UIDRef& conditionRef, IConditionTag::UnderlineIndicatorAppearance newAppearance) = 0;

 virtual ErrorCode GetConditionAppearance(const UIDRef& conditionRef, IConditionTag::UnderlineIndicatorAppearance& appearance) const = 0;

 virtual ErrorCode SetConditionOptions(const UIDRef& conditionRef, 
 const WideString& newName, 
 UID newColorUID,
 IConditionTag::IndicatorMethod newMethod, 
 IConditionTag::UnderlineIndicatorAppearance newAppearance) = 0;

 virtual ErrorCode GetConditionOptions(const UIDRef& conditionRef,
 WideString& name, 
 UID& colorUID,
 IConditionTag::IndicatorMethod& method, 
 IConditionTag::UnderlineIndicatorAppearance& appearance) const = 0;

 virtual ErrorCode SetConditionVisibleState(const UIDRef& conditionRef, bool16 visibleState) = 0;

 virtual ErrorCode GetConditionVisibleState(const UIDRef& conditionRef, bool16& visibleState) const = 0;

 virtual ErrorCode ApplyConditionsToText(const UIDRef& textModelRef, TextIndex start, int32 len, const K2Vector<UID>& conditionsToApply, bool16 removeExisting = kFalse) = 0;
 
 virtual ErrorCode RemoveConditionsFromText(const UIDRef& textModelRef, TextIndex start, int32 len, const K2Vector<UID>& conditionsToRemove) = 0;

 virtual K2Vector<UID> GetAppliedConditions(const UIDRef& textModelRef, TextIndex startPosition, TextIndex endPosition, int32 *length = nil) = 0;

 virtual ErrorCode GetAppliedConditions(const UIDRef& textModelRef, const RangeData& rangeData, UIDList& appliedToAllChars, UIDList& appliedToSomeChars, bool16* rangeHasUnconditionalChars = nil) = 0;

 virtual void GetFirstAvailableDefaultConditionName(IWorkspace* ws, WideString& newName) = 0;

 virtual void GetNextDefaultConditionColor(IWorkspace* ws, UID& newColor) = 0;
 
 virtual ErrorCode FindCondition(IWorkspace* ws, const WideString& name, UID& conditionUID) = 0;

 virtual IConditionTagList* QueryActiveConditionList(IActiveContext* ac) = 0;

 virtual IConditionTagList* QueryConditionList(IDataBase* db) = 0;

 virtual ErrorCode SetShowConditionIndicators(IWorkspace* ws, IConditionalTextOptions::ConditionIndicatorsMode showIndicatorsMode) = 0;

 virtual ErrorCode ShowAllConditions(IWorkspace* ws, bool16 showConditions) = 0;

 virtual ErrorCode LoadConditions(IWorkspace* ws, const IDFile& sourceFile, bool16 loadConditionSets) = 0;
 

 typedef std::pair<UID, bool> ConditionSetElement;
 
 typedef std::vector< ConditionSetElement > ConditionSetElementList;
 
 virtual ErrorCode CreateConditionSet(IWorkspace* ws, const WideString& name, const ConditionSetElementList &conditionSetElements, UID* newConditionSetUID) = 0;
 
 virtual ErrorCode DeleteConditionSet(const UIDRef& conditionSetRef) = 0;
 
 virtual ErrorCode GetAllConditionSets(IWorkspace* ws, UIDList *conditionSets) = 0;
 
 virtual ErrorCode GetActiveConditionSet(IWorkspace* ws, UID &activeConditionSetUID) = 0;
 
 virtual ErrorCode SetActiveConditionSet(IWorkspace* ws, UID activeConditionSetUID) = 0;
 
 virtual ErrorCode GetConditionsInConditionSet(const UIDRef& conditionSetRef, ConditionSetElementList &conditionSetElements) = 0;
 
 virtual ErrorCode RedefineConditionSet(const UIDRef& conditionSetRef, const ConditionSetElementList &conditionSetElements) = 0;

 virtual ErrorCode SetConditionSetName(const UIDRef& conditionSetRef, const WideString& name) = 0;
 
 virtual ErrorCode GetConditionSetName(const UIDRef& conditionSetRef, WideString& name) = 0;
 
 virtual ErrorCode FindConditionSet(IWorkspace* ws, const WideString& name, UID &conditionSetUID) = 0;
 
 virtual ErrorCode GetFirstAvailableDefaultConditionSetName(IWorkspace* ws, WideString& newName) = 0;

 virtual IConditionTagSetList* QueryActiveConditionSetList(IActiveContext* ac) = 0;

 virtual IConditionTagSetList* QueryConditionSetList(IDataBase* db) = 0;
 
 virtual ErrorCode LoadConditions(IWorkspace* ws, const std::string& sourceFile, bool16 loadConditionTagSets)=0;
 }; // end IConditionalTextFacade interface
}
#endif // define __ICONDITIONALTEXTFACADE__