SnpManipulateArticles Class Reference

Public Types
typedef KeyValuePair< UID, PMString >	ArticleInfo
typedef K2Vector< ArticleInfo >	ArticleList

Public Member Functions
	SnpManipulateArticles ()
virtual	~SnpManipulateArticles ()
ErrorCode	ListArticles (IDocument *doc)
ErrorCode	ListArticlesForPageItems (IDocument *doc, ILayoutTarget *layoutTarget)
ErrorCode	AddToExistingArticle (IDocument *doc, ILayoutTarget *layoutTarget)
ErrorCode	AddToNewArticle (IDocument *doc, ILayoutTarget *layoutTarget, const PMString &articleName)
ErrorCode	RemoveFromArticle (IDocument *doc, ILayoutTarget *layoutTarget)

Detailed Description

• How to retrieve articles for a document,
• How to retrieve articles to which a page item belongs,
• How to add page items to existing articles,
• How to create new articles and add page items to them,
• How to remove page items from articles.

Member Typedef Documentation

typedef KeyValuePair< UID, PMString > SnpManipulateArticles::ArticleInfo

Article UID and name mapping.

Constructor & Destructor Documentation

SnpManipulateArticles::SnpManipulateArticles ( )

inline

Constructor.

virtual SnpManipulateArticles::~SnpManipulateArticles ( )

inlinevirtual

Destructor.

Member Function Documentation

ErrorCode SnpManipulateArticles::AddToExistingArticle	(	IDocument *	doc,
		ILayoutTarget *	layoutTarget
	)

Adds selected page items to an existing article.

Parameters

doc	The document to which page items belong.
layoutTarget	ILayoutTarget for retrieving selected page items.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpManipulateArticles::AddToNewArticle	(	IDocument *	doc,
		ILayoutTarget *	layoutTarget,
		const PMString &	articleName
	)

Creates a new article and add selected page items to it.

Parameters

doc	The document to which page items belong.
layoutTarget	ILayoutTarget for retrieving selected page items.
articleName	Name for the new article.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpManipulateArticles::ListArticles

(

IDocument *

doc

)

Lists articles for a document.

Parameters

doc	The document.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpManipulateArticles::ListArticlesForPageItems	(	IDocument *	doc,
		ILayoutTarget *	layoutTarget
	)

Lists articles for specified page items.

Parameters

doc	The document to which page items belong.
layoutTarget	ILayoutTarget for retrieving selected page items.

Returns

kSuccess on success, other ErrorCode otherwise.

ErrorCode SnpManipulateArticles::RemoveFromArticle	(	IDocument *	doc,
		ILayoutTarget *	layoutTarget
	)

Removes selected page items from an article.

Parameters

doc	The document to which page items belong.
layoutTarget	ILayoutTarget for retrieving selected page items.

Returns

kSuccess on success, other ErrorCode otherwise.