RVC::TEXTOBJ Class Reference

Manages RVC::OBJTYPE_Text and derived RVC objects. More...

#include <rvc/textobj.h>

Inheritance diagram for RVC::TEXTOBJ:

[legend]

Classes
class	GETOBJFILTER_HASTITLE
	Text object selection filter to determine if the text object is selectable and has as its first line a title string matching the string given. More...
class	GETOBJFILTER_ISSELECTABLE
	Text object selection filter to determine if the text object is selectable under the parent object. More...
class	MAKEPARMS
Public Member Functions
	TEXTOBJ (const RVC::TEXTOBJ &obj)
	TEXTOBJ ()
virtual	~TEXTOBJ ()
INT32	Append (const MISTRING &string)
INT32	Append (const MIUNICODE *line)
ERRVALUE	Link (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, const FILEPATH &LinkFile, CHAR_ENCODING encoding=CHAR_ENCODING_ISO_2022, const CREDENTIALS *Credentials=0)
ERRVALUE	Make (RVC::OBJITEM &ObjItem, const MAKEPARMS &MakeParms, const char Source=0, const CREDENTIALS Credentials=0)
ERRVALUE	Make (RVC::OBJITEM &ObjItem, const char Source=0, const CREDENTIALS Credentials=0)
ERRVALUE	Make (const RVC::OBJECT &parent, const MAKEPARMS &MakeParms, const RVC::DESCRIPTOR &Descriptor, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE	Make (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
RVC::TEXTOBJ &	operator= (const RVC::TEXTOBJ &rhs)
ERRVALUE	Read (MISTRING &string)
ERRVALUE	ReadLine (MISTRING &string)
ERRVALUE	Reset ()
ERRVALUE	Write (const MISTRING &string)
Static Public Member Functions
static RVC::OBJTYPESET	GetObjTypeSet ()
static bool	IsText (RVC::OBJTYPE ObjType)
Protected Member Functions
void	GetExtraValue (UINT32 offset, UINT32 &value) const
void	GetExtraValue (UINT32 offset, UINT16 &value) const
void	GetMetadataFormat (UINT8 &format) const
ERRVALUE	Link (const RVC::OBJECT &parent, OBJMAKEPARMS &ObjMakeParms, const FILEPATH &LinkFile, CHAR_ENCODING encoding=CHAR_ENCODING_ISO_2022)
ERRVALUE	Make (const OBJECT &parent, OBJMAKEPARMS &ObjMakeParms)
ERRVALUE	OpenObject (OPENMODE OpenFlags, TEXTINFO &newinfo, int HeaderSize, int HeaderType, MDLGPARENT parent, const CREDENTIALS *Credentials)

Detailed Description

Manages RVC::OBJTYPE_Text and derived RVC objects.

RVC Object Types that this class supports:

Default RVC Object Type for this class: RVC::OBJTYPE_Text.

Valid parents for this class:

All objects are valid parents

Constructor & Destructor Documentation

RVC::TEXTOBJ::TEXTOBJ ( )

Default constructor.

RVC::TEXTOBJ::TEXTOBJ ( const RVC::TEXTOBJ & obj )

Copy constructor.

virtual RVC::TEXTOBJ::~TEXTOBJ ( ) [virtual]

Destructor.

Member Function Documentation

INT32 RVC::TEXTOBJ::Append ( const MISTRING & string )

Write a MISTRING to the text object Appends new line value based on the OS.

Returns:: : Number of characters written

INT32 RVC::TEXTOBJ::Append ( const MIUNICODE * line )

Append a string to the text object Appends new line value based on the OS.

Returns:: : Number of characters written

void RVC::TEXTOBJ::GetExtraValue	(	UINT32	offset,
		UINT32 &	value
	)			const `[protected]`

void RVC::TEXTOBJ::GetExtraValue	(	UINT32	offset,
		UINT16 &	value
	)			const `[protected]`

void RVC::TEXTOBJ::GetMetadataFormat ( UINT8 & format ) const [protected]

static RVC::OBJTYPESET RVC::TEXTOBJ::GetObjTypeSet ( ) [static]

Get correct OBJTYPESET for all text OBJTYPE's.

Returns:: OBJTYPESET for all text OBJTYPE's

Reimplemented in RVC::SCRIPT, and RVC::SERIALIZE.

static bool RVC::TEXTOBJ::IsText ( RVC::OBJTYPE ObjType ) [static]

Determine if the object type is a text object.

ERRVALUE RVC::TEXTOBJ::Link	(	const RVC::OBJECT &	parent,
		OBJMAKEPARMS &	ObjMakeParms,
		const FILEPATH &	LinkFile,
		CHAR_ENCODING	encoding = `CHAR_ENCODING_ISO_2022`
	)			`[protected]`

ERRVALUE RVC::TEXTOBJ::Link	(	const RVC::OBJECT &	parent,
		const RVC::DESCRIPTOR &	Descriptor,
		const FILEPATH &	LinkFile,
		CHAR_ENCODING	encoding = `CHAR_ENCODING_ISO_2022`,
		const CREDENTIALS *	Credentials = `0`
	)

Create a new rvc text object that is a link to an external text file.

Parameters:

	parent	Parent rvc object to create text object under
	Descriptor	Name of new rvc text object
	LinkFile	Path to external text file to link to, will attempt relative path
	encoding	Encoding of text file
	Credentials	User credentials passed in, NULL for default behavior

ERRVALUE RVC::TEXTOBJ::Make	(	const OBJECT &	parent,
		OBJMAKEPARMS &	ObjMakeParms
	)			`[protected]`

ERRVALUE RVC::TEXTOBJ::Make	(	RVC::OBJITEM &	ObjItem,
		const MAKEPARMS &	MakeParms,
		const char *	Source = `0`,
		const CREDENTIALS *	Credentials = `0`
	)

Create a new rvc text object.

Parameters:

	ObjItem	Parent object and DESCRIPTOR of object to create, new location RETURNED
	Source	Source of rvc text object creator, default is GetAppName()
	Credentials	User credentials passed in, NULL for default behavior

ERRVALUE RVC::TEXTOBJ::Make	(	RVC::OBJITEM &	ObjItem,
		const char *	Source = `0`,
		const CREDENTIALS *	Credentials = `0`
	)

Create a new rvc text object.

Parameters:

	ObjItem	Parent object and DESCRIPTOR of object to create, new location RETURNED
	Source	Source of rvc text object creator, default is GetAppName()
	Credentials	User credentials passed in, NULL for default behavior

ERRVALUE RVC::TEXTOBJ::Make	(	const RVC::OBJECT &	parent,
		const MAKEPARMS &	MakeParms,
		const RVC::DESCRIPTOR &	Descriptor,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Create a new rvc text object.

Parameters:

	parent	Parent rvc object to create text object under
	Descriptor	Name of new rvc text object
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

ERRVALUE RVC::TEXTOBJ::Make	(	const RVC::OBJECT &	parent,
		const RVC::DESCRIPTOR &	Descriptor,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Create a new rvc text object.

Parameters:

	parent	Parent rvc object to create text object under
	Descriptor	Name of new rvc text object
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

ERRVALUE RVC::TEXTOBJ::OpenObject	(	OPENMODE	OpenFlags,
		TEXTINFO &	newinfo,
		int	HeaderSize,
		int	HeaderType,
		MDLGPARENT	parent,
		const CREDENTIALS *	Credentials
	)			`[protected]`

RVC::TEXTOBJ& RVC::TEXTOBJ::operator= ( const RVC::TEXTOBJ & rhs )

Assignment.

Reimplemented from RVC::OBJECT.

Reimplemented in RVC::DBPARM, RVC::DISPGROUP, RVC::DISPLAYOUT, RVC::DISPPARM, RVC::DISPSIM3D, RVC::DISPWINDOW, RVC::HOUGHPARMS, RVC::LAYOUTTEMPLATE, RVC::METADATA, RVC::MOSAICLAYOUT, RVC::QUERY, RVC::SCRIPT, RVC::SERIALIZE, and RVC::SML.

ERRVALUE RVC::TEXTOBJ::Read ( MISTRING & string )

Read text into the string, reads the whole object.

Parameters:

string

String to read into

Reimplemented in RVC::METADATA.

ERRVALUE RVC::TEXTOBJ::ReadLine ( MISTRING & string )

Read a line of text into the string This method cannot be used if current instance was opened with Make().

This method does not remove end of line codes

Returns:: : EEndOfFile if read past the end or <0 of error or ==0 if no error

Parameters:

string

String to read into

ERRVALUE RVC::TEXTOBJ::Reset ( )

Reset the ReadLine() position to the beginning of the object.

ERRVALUE RVC::TEXTOBJ::Write ( const MISTRING & string )

Write a string to the text object, replacing the string in the existing object.

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

rvc/textobj.h

RVC::TEXTOBJ Class Reference

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation