SnpTextAttrHelper.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Developer Technologies
// 
// $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 __SnpTextAttrHelper_H_DEFINED__
#define __SnpTextAttrHelper_H_DEFINED__

class IAttrReport;
 
namespace SnpTextAttrHelper {

// TODO Align with coding conventions

template <class TextAttrType, class _Val_Type>
ErrorCode GetTextAttribute(const InDesign::TextRange& textRange, 
 const ClassID& attrClassID, 
 _Val_Type& value)
{
 // Assume failure.
 ErrorCode status = kFailure;
 do
 {
 // Check if the text range is valid.
 if (textRange.IsValid() == kFalse) 
 {
 SNIPLOG("textRange is invalid - you must have some text selected first.");
 break;
 }

 // Query the text model and get the range data, 
 InterfacePtr<ITextModel> textModel(textRange.QueryModel());
 RangeData rangeData = textRange.GetRange();
 
 // Query the compose scanner to access text attributes
 InterfacePtr<IComposeScanner> composeScanner(textModel, UseDefaultIID());
 if (composeScanner == nil) 
 {
 ASSERT(composeScanner); break;
 }
 
 // Query attribute report interface
 int32 attrLen = 0;
 InterfacePtr<const IAttrReport> attrReport(composeScanner->QueryAttributeAt(rangeData, attrClassID, &attrLen));
 if (attrReport == nil) 
 {
 SNIPLOG("Could not find text attribute with Class ID 0x%X on the selected text!", attrClassID.Get());
 break;
 }
 
 // Query the attribute interface
 InterfacePtr<TextAttrType> attr(attrReport, TextAttrType::kDefaultIID);
 if (attr == nil) 
 {
 SNIPLOG("attr is nil! (Class ID 0x%X)", attrClassID.Get()); 
 break;
 }
 
 // Get the attribute value.
 const _Val_Type tempValue = attr->Get();
 value = tempValue;
 status = kSuccess;
 } while (false);

 return status;
}

ErrorCode GetTextFontStyleAttribute(const InDesign::TextRange& textRange, 
 const ClassID& attrClassID, 
 PMString& fontName);

ErrorCode GetTextBool16Attribute(const InDesign::TextRange& textRange, 
 const ClassID& attrClassID, 
 bool16& value);

template <class TextAttrType, class _Val_Type>
IAttrReport* CreateTextAttribute(const ClassID& attrClassID, 
 const _Val_Type& value)
{
 IAttrReport* attrReport = nil;
 do {
 // create the text attribute boss
 InterfacePtr<TextAttrType> attr(::CreateObject2<TextAttrType>(attrClassID));
 if (attr == nil)
 {
 ASSERT_FAIL("attr is nil!");
 break;
 }
 // set the attribute value
 const _Val_Type tempValue = value;
 attr->Set(tempValue);

 InterfacePtr<IAttrReport> localAttrReport(attr, UseDefaultIID());
 attrReport = localAttrReport.forget();
 } while (false);
 ASSERT(attrReport);

 return attrReport;
}


IAttrReport* CreateTextFontStyleAttribute(const ClassID& attrClassID, 
 const PMString& fontName);

IAttrReport* CreateTextBool16Attribute(const ClassID& attrClassID, 
 const bool16& fontName);

ErrorCode SetTextBool16Attribute(const InDesign::TextRange& textRange, 
 const ClassID& attrClassID, 
 const bool16 value,
 const ClassID& whichStrand = kCharAttrStrandBoss);

ErrorCode SetTextInt16Attribute(const InDesign::TextRange& textRange, 
 const ClassID& attrClassID, 
 const int16 value,
 const ClassID& whichStrand = kCharAttrStrandBoss);


}; // end namespace SnpTextAttrHelper

#endif //#define __SnpTextAttrHelper_H_DEFINED__

//End, SnpTextAttrHelper.h