Usage information for an optional content group, providing context that an application can use to automatically show or hide content in the optional content group. This is optional. More...

#include <jawsmako/optionalcontent.h>

Inheritance diagram for JawsMako::IOptionalContentGroupUsage:

[legend]

Public Member Functions
virtual	~IOptionalContentGroupUsage ()
virtual IOptionalContentGroupUsagePtr	clone () const =0
	Clone the usage information.
virtual void	setLanguage (const U8String &language, bool preferred=false)=0
	Set the language of the content controlled by this optional content group, and whether or not it should be considered "preferred" if there is no exact match for the language used by the viewer's.
virtual U8String	getLanguage () const =0
	Get the language for the group, which may be an empty string if no language has been set.
virtual bool	getLanguageIsPreferred () const =0
	Get whether the language of this optional content group should be considered "preferred".
virtual void	setExportVisibility (eOptionalContentVisibility visibility)=0
	Set if the content in the group should be present when the content is "exported" to a format that does not support optional content.
virtual eOptionalContentVisibility	getExportVisibility () const =0
	Get whether the content in the group should be present when the content is "exported" to a format that does not support optional content.
virtual void	setZoomVisibility (float minimumZoom, float maximumZoom)=0
	Set if the content should be visible between the given zoom levels. Setting maximumZoom to a negative value indicates infinity.
virtual void	getZoomVisibility (float &minimumZoom, float &maximumZoom) const =0
	Get the zoom levels between which this content is visible. A negative maximumZoom indicates infinity.
virtual void	setPrintVisibility (eOptionalContentVisibility visibility, const U8String &description=U8String())=0
	Set if the content in the group should be present when the content is printed, and optionally an informative string describing the kind of content.
virtual eOptionalContentVisibility	getPrintVisibility () const =0
	Get whether the content in the group should be present when the content is printed.
virtual U8String	getPrintVisibilityDescription () const =0
	Get the print visibility description, which may be an empty string.
virtual void	setViewVisibility (eOptionalContentVisibility visibility)=0
	Set if the content in the group should be visible when the content is viewed.
virtual eOptionalContentVisibility	getViewVisibility () const =0
	Get whether the content in the group should be visible when the content is viewed.
virtual void	setUsers (const U8String &type, const CU8StringVect &users)=0
	Get the type and users for which this content is primarily intended.
virtual CU8StringVect	getUsers (U8String &type) const =0
	Get the type and users for which this content is primarily intended.
virtual void	setPageElement (const U8String &type)=0
	Sets a description of the page element that is represented by the optional content group.
virtual U8String	getPageElement () const =0
	Gets a description of the page element that is represented by the optional content group. May be an empty string.
virtual eOptionalContentVisibility	recommendedVisibilityForCategories (const COCCategoryVect &categories) const =0
	Determine the recommended state from this usage information for the given usage categories.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static JAWSMAKO_API IOptionalContentGroupUsagePtr	create (const IJawsMakoPtr &jawsMako)
	Create usage information.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

Usage information for an optional content group, providing context that an application can use to automatically show or hide content in the optional content group. This is optional.

These are only consulted when making visibility decisions if the document's IOptionalContent specifies that the usage for this group should be used, and even then only some attributes may be consulted depending on how the usages are configured. See IOptionalContentGroupUsageApplication.

Constructor & Destructor Documentation

◆ ~IOptionalContentGroupUsage()

virtual JawsMako::IOptionalContentGroupUsage::~IOptionalContentGroupUsage ( )

inlinevirtual

Member Function Documentation

◆ clone()

virtual IOptionalContentGroupUsagePtr JawsMako::IOptionalContentGroupUsage::clone ( ) const

pure virtual

Clone the usage information.

Returns: IOptionalContentGroupUsagePtr The cloned usage information.

◆ create()

JAWSMAKO_API IOptionalContentGroupUsagePtr JawsMako::IOptionalContentGroupUsage::create ( const IJawsMakoPtr & jawsMako )

static

Create usage information.

Parameters

jawsMako The IJawsMako object.

Returns: IOptionalContentGroupUsagePtr The new usage information.

◆ getExportVisibility()

virtual eOptionalContentVisibility JawsMako::IOptionalContentGroupUsage::getExportVisibility ( ) const

pure virtual

Get whether the content in the group should be present when the content is "exported" to a format that does not support optional content.

Returns: eOptionalContentVisibility The visibility status for export.

◆ getLanguage()

virtual U8String JawsMako::IOptionalContentGroupUsage::getLanguage ( ) const

pure virtual

Get the language for the group, which may be an empty string if no language has been set.

Returns: U8String The language of the group, or an empty string if none is set.

◆ getLanguageIsPreferred()

virtual bool JawsMako::IOptionalContentGroupUsage::getLanguageIsPreferred ( ) const

pure virtual

Get whether the language of this optional content group should be considered "preferred".

Returns: bool True if the language is preferred, false otherwise.

◆ getPageElement()

virtual U8String JawsMako::IOptionalContentGroupUsage::getPageElement ( ) const

pure virtual

Gets a description of the page element that is represented by the optional content group. May be an empty string.

Returns: U8String The type of page element, or an empty string if none is set.

◆ getPrintVisibility()

virtual eOptionalContentVisibility JawsMako::IOptionalContentGroupUsage::getPrintVisibility ( ) const

pure virtual

Get whether the content in the group should be present when the content is printed.

Returns: eOptionalContentVisibility The visibility status for print.

◆ getPrintVisibilityDescription()

virtual U8String JawsMako::IOptionalContentGroupUsage::getPrintVisibilityDescription ( ) const

pure virtual

Get the print visibility description, which may be an empty string.

Returns: U8String The print visibility description, or an empty string if none is set.

◆ getUsers()

virtual CU8StringVect JawsMako::IOptionalContentGroupUsage::getUsers ( U8String & type ) const

pure virtual

Get the type and users for which this content is primarily intended.

Parameters

type	Reference to receive the type of user.

Returns: The usernames, or an empty array if none are present.

◆ getViewVisibility()

virtual eOptionalContentVisibility JawsMako::IOptionalContentGroupUsage::getViewVisibility ( ) const

pure virtual

Get whether the content in the group should be visible when the content is viewed.

Returns: eOptionalContentVisibility The visibility status for view.

◆ getZoomVisibility()

virtual void JawsMako::IOptionalContentGroupUsage::getZoomVisibility	(	float &	minimumZoom,
		float &	maximumZoom ) const

pure virtual

Get the zoom levels between which this content is visible. A negative maximumZoom indicates infinity.

Parameters

[out]	minimumZoom	Reference to receive the minimum zoom level.
[out]	maximumZoom	Reference to receive the maximum zoom level.

◆ recommendedVisibilityForCategories()

virtual eOptionalContentVisibility JawsMako::IOptionalContentGroupUsage::recommendedVisibilityForCategories ( const COCCategoryVect & categories ) const

pure virtual

Determine the recommended state from this usage information for the given usage categories.

Uses the algorithm on page 383 of the PDF 1.7 specification, with the following modifications:

Zoom is not considered and always assumed ON
User is not considered and always assumed ON
Language is considered ON if the language is preferred.

May return Unchanged.

Parameters

categories The categories to consider.

Returns: eOptionalContentVisibility The recommended visibility state for the categories.

◆ setExportVisibility()

virtual void JawsMako::IOptionalContentGroupUsage::setExportVisibility ( eOptionalContentVisibility visibility )

pure virtual

Set if the content in the group should be present when the content is "exported" to a format that does not support optional content.

Parameters

visibility The visibility status to set.

◆ setLanguage()

virtual void JawsMako::IOptionalContentGroupUsage::setLanguage	(	const U8String &	language,
		bool	preferred = false )

pure virtual

Set the language of the content controlled by this optional content group, and whether or not it should be considered "preferred" if there is no exact match for the language used by the viewer's.

Parameters

language	A "Natural Language Specification" string representing the language and possible a locale, such as "en-US". Pass an empty string to specify no particular language.
preferred	Whether this should be considered preferred if no exact match for the user's viewing language is found.

◆ setPageElement()

virtual void JawsMako::IOptionalContentGroupUsage::setPageElement ( const U8String & type )

pure virtual

Sets a description of the page element that is represented by the optional content group.

Parameters

type	Should be either "HF" (Header or footer), "FG" (foreground content), "BG" (Background content), "L" (Logo) or an empty string indicating no particular page element is represented.

◆ setPrintVisibility()

virtual void JawsMako::IOptionalContentGroupUsage::setPrintVisibility	(	eOptionalContentVisibility	visibility,
		const U8String &	description = U8String() )

pure virtual

Set if the content in the group should be present when the content is printed, and optionally an informative string describing the kind of content.

Parameters

visibility	The visibility status to set.
description	An optional description of the content, which may be an empty string.

◆ setUsers()

virtual void JawsMako::IOptionalContentGroupUsage::setUsers	(	const U8String &	type,
		const CU8StringVect &	users )

pure virtual

Get the type and users for which this content is primarily intended.

Parameters

type	The type of user, which should be either "Ind" (Individual), "Ttl" (Title), or "Org" (Organization). Must not be empty unless the users vector is also empty (which will cause the user information to be ignored for visibility determination)
users	The usernames.

◆ setViewVisibility()

virtual void JawsMako::IOptionalContentGroupUsage::setViewVisibility ( eOptionalContentVisibility visibility )

pure virtual

Set if the content in the group should be visible when the content is viewed.

Parameters

visibility The visibility status to set.

◆ setZoomVisibility()

virtual void JawsMako::IOptionalContentGroupUsage::setZoomVisibility	(	float	minimumZoom,
		float	maximumZoom )

pure virtual

Set if the content should be visible between the given zoom levels. Setting maximumZoom to a negative value indicates infinity.

Parameters

minimumZoom	The minimum zoom level at which the content is visible.
maximumZoom	The maximum zoom level at which the content is visible.

The documentation for this class was generated from the following file:

jawsmako/optionalcontent.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~IOptionalContentGroupUsage()

Member Function Documentation

◆ clone()

◆ create()

◆ getExportVisibility()

◆ getLanguage()

◆ getLanguageIsPreferred()

◆ getPageElement()

◆ getPrintVisibility()

◆ getPrintVisibilityDescription()

◆ getUsers()

◆ getViewVisibility()

◆ getZoomVisibility()

◆ recommendedVisibilityForCategories()

◆ setExportVisibility()

◆ setLanguage()

◆ setPageElement()

◆ setPrintVisibility()

◆ setUsers()

◆ setViewVisibility()

◆ setZoomVisibility()