Facade::IBookmarkFacade Class Reference

#include <IBookmarkFacade.h>

Inheritance diagram for Facade::IBookmarkFacade:

Public Types
enum	{ kDefaultIID = IID_IBOOKMARKFACADE }

Public Member Functions
virtual ErrorCode	CreateBookmark (UIDRef destination, UID parentBookmark, UIDRef *newBookmark=nil, const PMString &bookmarkName="", int32 indentLevel=0)=0
virtual ErrorCode	DeleteBookmark (UIDList bookmarks, bool16 deleteDest=kTrue)=0
virtual ErrorCode	MoveBookmark (UIDRef bookmark, UIDRef newParent, int32 newIndex)=0
virtual ErrorCode	RenameBookmark (UIDRef bookmark, const PMString &newName)=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

A high level API for dealing with bookmark objects. To use this Facade, include this header file and use the following example syntax: result = Utils<Facade::IBookmarkFacade>()->CreateBookmark( ... );

Author

Jianlan Song

Member Function Documentation

virtual ErrorCode Facade::IBookmarkFacade::CreateBookmark ( UIDRef  destination, UID  parentBookmark, UIDRef *  newBookmark = nil, const PMString &  bookmarkName = "", int32  indentLevel = 0  )

pure virtual

Creates a new bookmark.

Parameters

destination	- destination associated with the new bookmark.
parentBookmark	- Parent of the bookmark.
newBookmark	- [OUT] Returns newly created bookmark if pointer is non-nil.
bookmarkName	- name of the bookmark. Default to be empty string in which case a unique name will be generated.
indentLevel	- Indent level of the bookmark. Default to be 0 which is the topmost level.

Returns

ErrorCode - result of the operation.

virtual ErrorCode Facade::IBookmarkFacade::DeleteBookmark ( UIDList  bookmarks, bool16  deleteDest = kTrue  )

pure virtual

Deletes bookmarks.

Parameters

bookmarks	- Bookmarks to be deleted.
deleteDest	- kTrue if delete destinations as well. kFalse otherwise.

Returns

ErrorCode - result of the operation.

virtual ErrorCode Facade::IBookmarkFacade::MoveBookmark ( UIDRef  bookmark, UIDRef  newParent, int32  newIndex  )

pure virtual

Moves bookmark.

Parameters

bookmark	- Bookmark to be moved.
newParent	- New parent to move the bookmark to.
newIndex	- New index inside the parent to insert the bookmark.

Returns

ErrorCode - result of the operation.

virtual ErrorCode Facade::IBookmarkFacade::RenameBookmark ( UIDRef  bookmark, const PMString &  newName  )

pure virtual

Rename a bookmark.

Parameters

bookmark	- Bookmark to be renamed.
newName	- new name for the bookmark.

Returns

ErrorCode - result of the operation.