InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IViewColorScheme Class Referenceabstract

#include <IViewColorScheme.h>

Inheritance diagram for IViewColorScheme:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IVIEWCOLORSCHEME }
 

Public Member Functions

virtual void SetTextColor (const RealAGMColor &color)=0
 
virtual const RealAGMColor & GetTextColor ()=0
 
virtual void SetBackGroundColor (const RealAGMColor &color)=0
 
virtual const RealAGMColor & GetBackGroundColor ()=0
 
virtual const RealAGMColor & GetBlendedColor (const PMReal &opacity, bool16 textOnBackground=kTrue)=0
 
virtual const RealAGMColor & GetBlendedColor (const RealAGMColor &foreColor, const RealAGMColor &backColor, const PMReal &opacity)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

This interface is used as a place to store view specific color data for a story or galley view. They are also used to pass data to the GalleySettingsCommands for control of display background and text colors. The implementations of these on the kWritingModePanelBoss are kept in sync with IGalleySettings cooresponding to colors.

Member Function Documentation

virtual const RealAGMColor& IViewColorScheme::GetBackGroundColor ()
pure virtual

Get the view background color

Returns
RGB value defining color for view background.
virtual const RealAGMColor& IViewColorScheme::GetBlendedColor (const PMReal & opacity,
bool16 textOnBackground = kTrue 
)
pure virtual

Blend text color with background color at a given opacity give back combined color

Parameters
opacity- how transparent 0.0 to 1.0
textOnBackground- drawing text on background color kTrue, background color on text color kFalse.
Returns
RGB value for blended color.
virtual const RealAGMColor& IViewColorScheme::GetBlendedColor (const RealAGMColor & foreColor,
const RealAGMColor & backColor,
const PMReal & opacity 
)
pure virtual

Blend two arbitrary colors (foreColor on backColor) at a given opacity

Parameters
foreColor- color to combine with backColor
backColor- color to combine with foreColor
opacity- how transparent 0.0 to 1.0
Returns
RGB value for blended color.
virtual const RealAGMColor& IViewColorScheme::GetTextColor ()
pure virtual

Get the current text color

Returns
RGB value of defining the color of the text for story/galley views.
virtual void IViewColorScheme::SetBackGroundColor (const RealAGMColor & color)
pure virtual

Set the color to use as the view background color

Parameters
color- RGB value defining color for view background
Returns
none.
virtual void IViewColorScheme::SetTextColor (const RealAGMColor & color)
pure virtual

Set the color to use as the text color

Parameters
color- RGB value defining color to display text as
Returns
none.