IDPSArticleExportPrefs Class Reference

#include <IDPSArticleExportPrefs.h>

Inheritance diagram for IDPSArticleExportPrefs:

Public Types
enum	{ kDefaultIID = IID_IDPSARTICLEEXPORTPREFS }
enum	ArticleBuilderArticleFormat { kArticleBuilderArticleFormatJPEG = 0, kArticleBuilderArticleFormatPNG, kArticleBuilderArticleFormatAUTO, kArticleBuilderArticleFormatPDF }
enum	ArticleBuilderJPEGQuality {   kArticleBuilderJPEGQualityMinimum, kArticleBuilderJPEGQualityLow, kArticleBuilderJPEGQualityMedium, kArticleBuilderJPEGQualityHigh,   kArticleBuilderJPEGQualityMaximum }

Public Member Functions
virtual uint32 const &	GetDimensionWidth () const =0
virtual void	SetDimensionWidth (uint32 const &dimensionWidth)=0
virtual uint32 const &	GetDimensionHeight () const =0
virtual void	SetDimensionHeight (uint32 const &dimensionHeight)=0
virtual ArticleBuilderArticleFormat	GetArticleFormat () const =0
virtual void	SetArticleFormat (ArticleBuilderArticleFormat articleFormat)=0
virtual ArticleBuilderJPEGQuality	GetJPEGQuality () const =0
virtual void	SetJPEGQuality (ArticleBuilderJPEGQuality quality)=0
virtual bool16	IsSmoothScrolling () const =0
virtual void	SetSmoothScrolling (bool16 smoothScrolling)=0
virtual bool16	IsHorizontalSwipe () const =0
virtual void	SetHorizontalSwipe (bool16 horizontalSwipe)=0
virtual PMString const &	GetLayout () const =0
virtual void	SetLayout (PMString const &layout)=0
virtual void	Reset ()=0
virtual void	Copy (IDPSArticleExportPrefs const *other)=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

Interface defining preferences to be used when exporting to .article

Member Enumeration Documentation

enum IDPSArticleExportPrefs::ArticleBuilderArticleFormat

Export format - currently removed and defaults to PDF

enum IDPSArticleExportPrefs::ArticleBuilderJPEGQuality

JPEG quality levels - currently removed and defaults to 'high'

Member Function Documentation

virtual void IDPSArticleExportPrefs::Copy ( IDPSArticleExportPrefs const *  other )

pure virtual

Copies one set of prefs into another

Note: use a command to actually set this!

Parameters

other

IN The preferences to copy

virtual ArticleBuilderArticleFormat IDPSArticleExportPrefs::GetArticleFormat ( ) const

pure virtual

Gets Article Format

Returns

Article Format

virtual uint32 const& IDPSArticleExportPrefs::GetDimensionHeight ( ) const

pure virtual

Gets Dimension Height

Returns

Dimension Height

virtual uint32 const& IDPSArticleExportPrefs::GetDimensionWidth ( ) const

pure virtual

Gets Target Dimension Width

Returns

Dimension Width

virtual ArticleBuilderJPEGQuality IDPSArticleExportPrefs::GetJPEGQuality ( ) const

pure virtual

Gets JPEG compression quality

Returns

JPEG compression quality

virtual PMString const& IDPSArticleExportPrefs::GetLayout ( ) const

pure virtual

Gets Layout

Returns

Layout

virtual bool16 IDPSArticleExportPrefs::IsHorizontalSwipe ( ) const

pure virtual

Is Horizontal Swipe Selection

Returns

True if Horizontal Swipe Selection

virtual bool16 IDPSArticleExportPrefs::IsSmoothScrolling ( ) const

pure virtual

Is Smooth Scrolling Selection

Returns

True if Smooth Scrolling Selection

virtual void IDPSArticleExportPrefs::Reset ( )

pure virtual

Reset the prefs to their default settings

virtual void IDPSArticleExportPrefs::SetArticleFormat ( ArticleBuilderArticleFormat  articleFormat )

pure virtual

Sets Article Format

Parameters

articleFormat

IN New Article Format

virtual void IDPSArticleExportPrefs::SetDimensionHeight ( uint32 const &  dimensionHeight )

pure virtual

Sets Dimension Height

Parameters

dimensionHeight

IN Dimension Height

virtual void IDPSArticleExportPrefs::SetDimensionWidth ( uint32 const &  dimensionWidth )

pure virtual

Sets Target Dimension Width

Parameters

dimensionWidth

IN Target Dimension Width

virtual void IDPSArticleExportPrefs::SetHorizontalSwipe ( bool16  horizontalSwipe )

pure virtual

Sets Is Horizontal Swipe Selection

Parameters

horizontalSwipe

IN New bool if Horizontal Swipe selection

virtual void IDPSArticleExportPrefs::SetJPEGQuality ( ArticleBuilderJPEGQuality  quality )

pure virtual

Sets JPEG compression quality

Parameters

quality

IN New compression quality

virtual void IDPSArticleExportPrefs::SetLayout ( PMString const &  layout )

pure virtual

Sets Layout

Parameters

layout

IN New Layout

virtual void IDPSArticleExportPrefs::SetSmoothScrolling ( bool16  smoothScrolling )

pure virtual

Sets Is Smooth Scrolling Selection

Parameters

smoothScrolling

IN New bool if Smooth Scrolling selection