RVC::TEXTOBJ Class Reference

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

#include <textobj.h>

Inheritance diagram for RVC::TEXTOBJ:

[legend]List of all members.

Public Member Functions
	TEXTOBJ ()
	TEXTOBJ (const RVC::TEXTOBJ &obj)
virtual	~TEXTOBJ ()
RVC::TEXTOBJ &	operator= (const RVC::TEXTOBJ &rhs)
ERRVALUE	Link (const RVC::OBJECT &parent, const RVC::OBJECTNAME &name, const RVC::OBJECTDESC &desc, const FILEPATH &LinkFile, CHAR_ENCODING encoding=CHAR_ENCODING_ISO_2022, const char *Source=0)
ERRVALUE	Make (const RVC::OBJECT &parent, const RVC::OBJECTNAME &name, const RVC::OBJECTDESC &desc, const char *Source=0)
ERRVALUE	Make (const RVC::OBJITEM &ObjItem, const char *Source=0)
ERRVALUE	Read (MISTRING &string)
ERRVALUE	ReadLine (MISTRING &string)
ERRVALUE	Write (const MISTRING &string)
ERRVALUE	WriteLine (const UNICODE *line)
ERRVALUE	WriteLine (const MISTRING &string)
Protected Member Functions
ERRVALUE	Make (const OBJECT &parent, const OBJECTNAME &name, const OBJECTDESC &desc, RVCTEXTINFO &newinfo, int HeaderSize, int HeaderType, const char *Source)
ERRVALUE	Read (INIHANDLE IniHandle, RVCTEXTINFO &newinfo, int HeaderSize, int HeaderType)
ERRVALUE	OpenObject (OPENMODE OpenFlags, RVCTEXTINFO &newinfo, int HeaderSize, int HeaderType, MDLGPARENT parent)
ERRVALUE	Write (INIHANDLE IniHandle, RVCTEXTINFO &newinfo, int HeaderSize, int HeaderType)

---

Detailed Description

Manages RVC::OBJTYPE_Text and derived RVC objects.

The interface currently wraps the MfText functions. Named TEXTOBJ because WIndows has a macro define (TEXT())

RVC Object Types that this class supports:

• RVC::OBJTYPE_Script_Query
• RVC::OBJTYPE_Script_SML
• RVC::OBJTYPE_Display_Sim3D
• RVC::OBJTYPE_Display_Group
• RVC::OBJTYPE_Display_Layout
• RVC::OBJTYPE_Disp2DWindow
• RVC::OBJTYPE_DispParm
• RVC::OBJTYPE_Text
• RVC::OBJTYPE_DatabaseParm
• RVC::OBJTYPE_Theme
• RVC::OBJTYPE_Metadata

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

Valid parents for this class:

• All objects are valid parents

Definition at line 96 of file textobj.h.

---

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

ERRVALUE RVC::TEXTOBJ::Link (  const RVC::OBJECT &  parent, const RVC::OBJECTNAME &  name, const RVC::OBJECTDESC &  desc, const FILEPATH &  LinkFile, CHAR_ENCODING  encoding = CHAR_ENCODING_ISO_2022, const char *  Source = 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 name  Name of new rvc text object desc  Description of new rvc text object LinkFile  Path to external text file to link to, will attempt relative path encoding  Encoding of text file Source  Source of rvc text object creator, default is GetAppName()

ERRVALUE RVC::TEXTOBJ::Make (  const OBJECT &  parent, const OBJECTNAME &  name, const OBJECTDESC &  desc, RVCTEXTINFO &  newinfo, int  HeaderSize, int  HeaderType, const char *  Source )  [protected]

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

Create a new rvc text object. Parameters: ObjItem  Parent rvc object to create text object under Source  Source of rvc text object creator, default is GetAppName()

ERRVALUE RVC::TEXTOBJ::Make (  const RVC::OBJECT &  parent, const RVC::OBJECTNAME &  name, const RVC::OBJECTDESC &  desc, const char *  Source = 0 )

Create a new rvc text object. Parameters: parent  Parent rvc object to create text object under name  Name of new rvc text object desc  Description of new rvc text object Source  Source of rvc text object creator, default is GetAppName()

ERRVALUE RVC::TEXTOBJ::OpenObject (  OPENMODE  OpenFlags, RVCTEXTINFO &  newinfo, int  HeaderSize, int  HeaderType, MDLGPARENT  parent )  [protected]

Parameters: OpenFlags  Open the raster object

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

Assignment.

ERRVALUE RVC::TEXTOBJ::Read (  INIHANDLE  IniHandle, RVCTEXTINFO &  newinfo, int  HeaderSize, int  HeaderType )  [protected]

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

Read text into the string, reads the whole object This method cannot be used if current instance was opened with Make(). 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::Write (  INIHANDLE  IniHandle, RVCTEXTINFO &  newinfo, int  HeaderSize, int  HeaderType )  [protected]

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

Write a string to the text object This method can only be used if current instance was created with Make(). Returns: : Number of characters written

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

Write a line of MISTRING characters to the text object This method can only be used if current instance was created with Make(). Appends new line value based on the OS Returns: : Number of characters written

ERRVALUE RVC::TEXTOBJ::WriteLine (  const UNICODE *  line  )

Write a line of characters to the text object This method can only be used if current instance was created with Make(). Appends new line value based on the OS Returns: : Number of characters written

---

Friends And Related Function Documentation

friend class GETOBJFILTER_ISSELECTABLE [friend]

Definition at line 101 of file textobj.h.

---

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

• rvc/textobj.h

---