IBookCmdData Class Reference

#include <IBookCmdData.h>

Inheritance diagram for IBookCmdData:

Public Types
enum	{ kDefaultIID = IID_IBOOKCMDDATA }

Public Member Functions
virtual IDFile	GetSysFile ()=0
virtual void	SetSysFile (const IDFile &sysFile)=0
virtual IDataBase::ProtectionLevel	GetProtectionLevel ()=0
virtual void	SetProtectionLevel (IDataBase::ProtectionLevel protection=IDataBase::kProtectMiniSave)=0
virtual IBook::openOptions	GetOpenOption ()=0
virtual void	SetOpenOption (IBook::openOptions options)=0
virtual const UIFlags	GetOpenUIFlag () const =0
virtual void	SetOpenUIFlag (const UIFlags uiFlag)=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

Command data interface associated with book commands.

See Also

kNewBookCmdBoss

kOpenBookCmdBoss

Member Function Documentation

virtual IBook::openOptions IBookCmdData::GetOpenOption ( )

pure virtual

Get the open options, either open exclusive or shared.

Parameters

none

Returns

IBook::openOptions the open option.

virtual const UIFlags IBookCmdData::GetOpenUIFlag ( ) const

pure virtual

Get the open UI flag.

Parameters

none

Returns

UIFlags the open UI flag.

virtual IDataBase::ProtectionLevel IBookCmdData::GetProtectionLevel ( )

pure virtual

Get the protection level when operate on the book(like open).

Parameters

none

Returns

IDataBase::ProtectionLevel the protection level.

virtual IDFile IBookCmdData::GetSysFile ( )

pure virtual

Get the book IDFile which the command will operate on.

Parameters

none

Returns

IDFile the book.

virtual void IBookCmdData::SetOpenOption ( IBook::openOptions  options )

pure virtual

Set the open book options.

Parameters

options

IN the open option.

virtual void IBookCmdData::SetOpenUIFlag ( const UIFlags  uiFlag )

pure virtual

Set the open UI flag.

Parameters

uiFlag

IN the UI flag for open operation.

virtual void IBookCmdData::SetProtectionLevel ( IDataBase::ProtectionLevel  protection = IDataBase::kProtectMiniSave )

pure virtual

Set the protection level for operating the book.

Parameters

protection

IN the protection level.

virtual void IBookCmdData::SetSysFile ( const IDFile &  sysFile )

pure virtual

Set the book IDFile.

Parameters

sysFile

IN the book to be operated on.