IGalleySettings.h

//========================================================================================
// 
// $File$
// 
// Owner: Kevin Van Wiel
// 
// $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 __IGalleySettings__
#define __IGalleySettings__

#include "WritingModeUIID2.h"
#include "WritingModeID2.h"
#include "IPMUnknown.h"

class RealAGMColor;
class IPMFont;

class IGalleySettings : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IGALLEYSETTINGS };

 enum CursorType{
 kNormalCursor = 0, 
 kThickCursor, 
 kBarbellCursor, 
 kBlockCursor};
 

 virtual bool16 GetSmoothText() const = 0;

 virtual void SetSmoothText(bool16 smoothText) = 0; 
 
 virtual bool16 GetShowParagraphStyleNames() = 0;
 
 virtual void SetShowParagraphStyleNames(bool16 showStyleNames) = 0;
 
 virtual bool16 GetShowParagraphBreakMarks() = 0;
 
 virtual void SetShowParagraphBreakMarks(bool16 showBreakMarks) = 0;
 
 virtual PMReal GetParagraphIndentMultiplier() = 0;
 
 virtual void SetParagraphIndentMultiplier(const PMReal indentMultiplier) = 0;
 
 virtual bool16 GetShowLineNumbers() = 0;
 
 virtual void SetShowLineNumbers(bool16 showLineNumbers) = 0;
 
 virtual bool16 GetIsGalleyAle() = 0;
 
 virtual void SetGalleyAle(bool16 isAle) = 0;
 
 virtual RealAGMColor &GetTextColor() = 0;
 
 virtual void SetTextColor(RealAGMColor &color) = 0;
 
 // Galley background color
 
 virtual RealAGMColor &GetBackgroundColor() = 0;
 
 virtual void SetBackgroundColor(RealAGMColor &color) = 0;
 
 virtual PMReal GetLeadingValue() const = 0;
 
 virtual void SetLeadingValue(PMReal leadingValue) = 0;
 
 virtual int32 GetOverrideCount() = 0;
 
 virtual const PMString &GetNthFontOverrideName(int32 n) = 0;

 virtual void SetNthFontOverrideName(int32 n, const PMString &name) = 0;

 virtual void DeleteNthFontOverrideName(int32 n) = 0;
 
 virtual void AppendFontOverrideName(const PMString &name) = 0;
 
 virtual bool16 IsAnOverrideFont(PMString fontFamilyName, IPMFont *font = nil) = 0;
 
 virtual IGalleySettings::CursorType GetCursorType() = 0;

 virtual void SetCursorType(CursorType type) = 0;
 
 virtual PMString GetDisplayFont() = 0;
 
 virtual void SetDisplayFont(PMString displayFont) = 0;

 virtual bool16 GetBlinkCursor() = 0;
 
 virtual void SetBlinkCursor(bool16 blinkOn) = 0;
 
 virtual void SetUseUserFontOverride(bool16 useUserOverride) = 0;
 
 virtual bool16 GetUseUserFontOverride() = 0;
 
 virtual void SetDisplayFontSize (const PMReal& fontSize) = 0;
 
 virtual PMReal GetDisplayFontSize () = 0;
 
 virtual void SetUseDisplayFont(bool16 useDisplayFont) = 0;

 virtual bool16 GetUseDisplayFont() = 0;

 virtual void SetInfoColumnWidth(PMReal width) = 0;
 
 virtual PMReal GetInfoColumnWidth() = 0;

 virtual void SetInfoColumnHidden(bool16 hidden) = 0;
 
 virtual bool16 GetInfoColumnHidden() = 0;
 
 
 enum OversetDisplayType {
 kNone = 0, 
 kDividerColor, 
 kDividerBackground, 
 kColorOnly,
 kBackgroundOnly,
 kMarginIndicator
 };
 
 virtual void SetOversetDisplayType(OversetDisplayType oversetType) = 0;
 
 virtual OversetDisplayType GetOversetDisplayType() = 0;
 
 virtual void SetOversetBackgroundColor(const RealAGMColor &color) = 0;
 
 virtual RealAGMColor GetOversetBackgroundColor() = 0;
 
 virtual void SetShowDepthRuler(bool16 showRuler) = 0;
 
 virtual bool16 GetShowDepthRuler() = 0;
 
 enum TextAntiAliasType {
 kStandardGrayDDR = 0,
 
 kColorDDR,
 
 kPreview
 }; 

 virtual void SetTextAntiAliasStyle(TextAntiAliasType aliasType) = 0;
 
 virtual TextAntiAliasType GetTextAntiAliasStyle() = 0;
 
 virtual void SetShowFootnotes(bool16 showFootnotes) = 0;

 virtual bool16 GetShowFootnotes() = 0;
 
 virtual void SetFootnoteDisplayColor(const RealAGMColor &color) = 0;
 
 virtual RealAGMColor &GetFootnoteDisplayColor() = 0;

};

#endif // __IGalleySettings__