IXMLImportPreferences Class Reference

#include <IXMLImportPreferences.h>

Inheritance diagram for IXMLImportPreferences:

Public Types
enum	{ kDefaultIID = IID_IXMLIMPORTPREFERENCES }
enum	kPrefType { kBool16, kInt32, kWideString }

Public Member Functions
virtual void	Initialize (IXMLImportOptionsPool *pool)=0
virtual void	Uninitialize ()=0
virtual int32	GetPrefCount () const =0
virtual kPrefType	GetNthPrefType (int32 n) const =0
virtual int32	GetNthPrefAsInt (int32 n) const =0
virtual bool16	GetNthPrefAsBool (int32 n) const =0
virtual WideString	GetNthPrefAsString (int32 n) const =0
virtual void	SetNthPref (int32 n, const int32 &newVal)=0
virtual void	SetNthPref (int32 n, const bool16 &newVal)=0
virtual void	SetNthPref (int32 n, const WideString &newVal)=0
virtual void	CommitChanges ()=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 for getting and setting the individual XML import options.

Member Enumeration Documentation

enum IXMLImportPreferences::kPrefType

Enumerates the different types of storage available for preferences.

Enumerator
kBool16	Stored as a bool16
kInt32	Stored as an int32
kWideString	Stored as a WideString

Member Function Documentation

virtual void IXMLImportPreferences::CommitChanges ( )

pure virtual

Commit the stored changes to the preferences. Until this method has been called the changes made by calling SetNthPref() don't really get moved into the preferences. Call this method after each of the changes for this set of preferences has been set appropriately

Implemented in CXMLImportPreferences.

virtual bool16 IXMLImportPreferences::GetNthPrefAsBool ( int32  n ) const

pure virtual

Get the value of the specified preference as a bool16

Parameters

n	- The preference you want to know about

Returns

- The bool value this preference is currently set to

Implemented in CXMLImportPreferences.

virtual int32 IXMLImportPreferences::GetNthPrefAsInt ( int32  n ) const

pure virtual

Get the value of the specified preference as an int32

Parameters

n	- The preference you want to know about

Returns

- The int32 this preference is currently set to

Implemented in CXMLImportPreferences.

virtual WideString IXMLImportPreferences::GetNthPrefAsString ( int32  n ) const

pure virtual

Get the value of the specified preference as a WideString

Parameters

n	- The preference you want to know about

Returns

- The string this preference is currently set to

Implemented in CXMLImportPreferences.

virtual kPrefType IXMLImportPreferences::GetNthPrefType ( int32  n ) const

pure virtual

Indicates what type of data a specific preference uses as its value.

Parameters

n	- The preference you want to gather info about.

Implemented in CXMLImportPreferences.

virtual int32 IXMLImportPreferences::GetPrefCount ( ) const

pure virtual

Get the number of preference held by this object

Returns

- The number of preferences you can get/set

Implemented in CXMLImportPreferences.

virtual void IXMLImportPreferences::Initialize ( IXMLImportOptionsPool *  pool )

pure virtual

Initialize the stored data. This is the only method that will need to be overridden if you inherit from CXMLImportPreferences rather than this file.

Note: Because this class doesn't know when you are done with the data you need to call Uninitialize when you are done with it.

Use stack based helper class XMLImportPreferencesInitializer below to avoid missing calling Uninitialize.

Parameters

pool	- The pool which owns the preferences

See Also

CXMLImportPreferences.h

Uninitional

Implemented in CXMLImportPreferences, XDocBkXTransXMLImportPrefs, XDocBkCALSContentXMLImportPrefs, XCatHndAcquirerXMLImportPrefs, and XDocBkXPostImpXMLImportPrefs.

virtual void IXMLImportPreferences::SetNthPref ( int32  n, const int32 &  newVal  )

pure virtual

Set the int32 value of a particular preference

Parameters

n	- The preference you want changed
newVal	- The new value you want the preference set to

Implemented in CXMLImportPreferences.

virtual void IXMLImportPreferences::SetNthPref ( int32  n, const bool16 &  newVal  )

pure virtual

Set the bool16 value of a particular preference

Parameters

n	- The preference you want changed
newVal	- The new value you want the preference set to

Implemented in CXMLImportPreferences.

virtual void IXMLImportPreferences::SetNthPref ( int32  n, const WideString &  newVal  )

pure virtual

Set the string value of a particular preference

Parameters

n	- The preference you want changed
newVal	- The new value you want the preference set to

Implemented in CXMLImportPreferences.

virtual void IXMLImportPreferences::Uninitialize ( )

pure virtual

Uninitialize the stored data. You need to override this method if you store your own data locally.

Implemented in CXMLImportPreferences.