RVC::OBJITEM

RVC::OBJITEM Class Reference

OBJITEM class for specifying a particular file and object. More...

#include <rvc/objitem.h>

List of all members.

Public Member Functions

void Clear ()
void CreateNew (const RVC::OBJITEM &ParentItem, RVC::OBJTYPE ObjType, const DESCRIPTOR &Descriptor)
void CreateNew (const DESCRIPTOR &Descriptor, RVC::OBJTYPE ObjType=RVC::OBJTYPE_All)
ERRVALUE GetCombinedPath (MISTRING &CombinedPath) const
DEPRECATED const DESCRIPTOR & GetDescriptor () const
MISTRING GetDisplayString (const CREDENTIALS *Credentials=0) const
void GetDisplayString (MISTRING &string, const CREDENTIALS *Credentials=0) const
const FILEPATH & GetFilePath () const
DEPRECATED const RVCGENINFO & GetInfo (const CREDENTIALS *Credentials=0) const
DEPRECATED RVCINODENUM GetInode (const CREDENTIALS *Credentials=0) const
DEPRECATED const MIUNICODE * GetObjectDescription (const CREDENTIALS *Credentials=0) const
const DESCRIPTOR & GetObjectDescriptor (const CREDENTIALS *Credentials=0) const
DEPRECATED const MIUNICODE * GetObjectName (const CREDENTIALS *Credentials=0) const
ERRVALUE GetObjectPath (MISTRING &ObjectPath, const CREDENTIALS *Credentials=0) const
RVC::OBJTYPE GetObjectType () const
bool GetParent (OBJITEM &ParentObjItem, const CREDENTIALS *Credentials=0) const
MISTRING GetToolTipString (const CREDENTIALS *Credentials=0) const
void GetToolTipString (MISTRING &string, const CREDENTIALS *Credentials=0) const
bool HasObjectDescription (const CREDENTIALS *Credentials=0) const
bool HasSameParent (const OBJITEM &rhs) const
bool IniRead (INIHANDLE handle, const char *group, const char *field)
void IniWrite (INIHANDLE handle, const char *group, const char *field, const CREDENTIALS *Credentials=0) const
bool IsAssigned () const
bool IsEqual (const OBJITEM &rhs, const CREDENTIALS *Credentials=0) const
bool IsExisting (const CREDENTIALS *Credentials=0) const
bool IsFileOnly () const
bool IsLessThan (const OBJITEM &rhs) const
bool IsLessThanChild (const OBJITEM &rhs) const
bool IsNewRequest (const CREDENTIALS *Credentials=0) const
bool IsResolved () const
bool IsSkipRequest (const CREDENTIALS *Credentials=0) const
 OBJITEM (const DESCRIPTOR &Descriptor)
DEPRECATED OBJITEM (const OBJECTNAME &name, const OBJECTDESC &desc, const char *source=0)
DEPRECATED OBJITEM (const FILEPATH &filename, RVCINODENUM inode, const CREDENTIALS *Credentials=0)
 OBJITEM (const FILEPATH &filename, const MISTRING &ObjectPath)
DEPRECATED OBJITEM (const FILEPATH &filename, const RVCGENINFO &ginfo)
 OBJITEM (const OBJITEM &rhs)
 OBJITEM ()
OBJITEM & operator= (const DESCRIPTOR &Descriptor)
OBJITEM operator= (const OBJITEM &rhs)
void SetCombinedPath (const MISTRING &CombinedPath, const CREDENTIALS *Credentials=0)
void SetFilePath (const FILEPATH &filepath)
DEPRECATED void SetItem (const FILEPATH &filename, RVCINODENUM inode, const CREDENTIALS *Credentials=0)
void SetItem (const FILEPATH &filename, const MISTRING &ObjectPath)
DEPRECATED void SetItem (const FILEPATH &filename, const RVCGENINFO &ginfo)
void SetItemToFile (const FILEPATH &filename, const CREDENTIALS *Credentials=0)
DEPRECATED void SetObjectDescription (const RVC::OBJECTDESC &NewDesc)
void SetObjectDescriptor (const DESCRIPTOR &NewDescriptor)
DEPRECATED void SetObjectInfo (const RVCGENINFO &ginfo)
DEPRECATED void SetObjectName (const RVC::OBJECTNAME &NewName)
void SetObjectPath (const MISTRING &ObjectPath, const CREDENTIALS *Credentials=0)
void SetObjectType (UINT32 objtype)
void SetSkipRequest ()
 ~OBJITEM ()

Static Public Member Functions

static void SetupOutputList (MILIST< OBJITEM > &oobjlist, const MILIST< OBJITEM > &iobjlist, const char *source=0)

Detailed Description

OBJITEM class for specifying a particular file and object.

Definition at line 161 of file objitem.h.

Constructor & Destructor Documentation

RVC::OBJITEM::OBJITEM (  )  [inline]

Default constructor.

Definition at line 172 of file objitem.h.

RVC::OBJITEM::OBJITEM ( const OBJITEM &  rhs  ) 

Copy constructor.

Parameters:
rhs  Object to copy from

DEPRECATED RVC::OBJITEM::OBJITEM ( const FILEPATH &  filename,
const RVCGENINFO &  ginfo 
)

Construct from FILEPATH and RVCGENINFO.

Deprecated:
Avoid use of RVCGENINFO
Parameters:
filename  Filename
ginfo  General info

RVC::OBJITEM::OBJITEM ( const FILEPATH &  filename,
const MISTRING &  ObjectPath 
) [inline]

Construct from FILEPATH and object path string.

Parameters:
filename  Filename
ObjectPath  Object path

Definition at line 192 of file objitem.h.

DEPRECATED RVC::OBJITEM::OBJITEM ( const FILEPATH &  filename,
RVCINODENUM  inode,
const CREDENTIALS *  Credentials = 0 
)

Construct from FILEPATH and object inode.

Deprecated:
Use version with object path.
Parameters:
filename  Filename
inode  Object inode

DEPRECATED RVC::OBJITEM::OBJITEM ( const OBJECTNAME &  name,
const OBJECTDESC &  desc,
const char *  source = 0 
)

Construct having specified name, description, optional source.

This useful when setting up an "output" OBJITEMLIST.

Deprecated:
Use DESCRIPTOR version.

RVC::OBJITEM::OBJITEM ( const DESCRIPTOR &  Descriptor  ) 

Construct having specified name, description, optional source.

This useful when setting up an "output" OBJITEMLIST.

RVC::OBJITEM::~OBJITEM (  ) 

Default destructor.

Member Function Documentation

void RVC::OBJITEM::Clear (  ) 

Clear the OBJITEM, refers to nothing.

void RVC::OBJITEM::CreateNew ( const RVC::OBJITEM &  ParentItem,
RVC::OBJTYPE  ObjType,
const DESCRIPTOR &  Descriptor 
)

Setup for use in prompt for or creation of new object with RVC::OBJITEM parent.

Parameters:
ParentItem  Parent object item reference
ObjType  New object type
Descriptor  New object name

void RVC::OBJITEM::CreateNew ( const DESCRIPTOR &  Descriptor,
RVC::OBJTYPE  ObjType = RVC::OBJTYPE_All 
)

Setup for use in prompt for or creation of new object with unspecified parent.

Does not alter currently set filepath.

Parameters:
Descriptor  New object descriptor
ObjType  New object type

ERRVALUE RVC::OBJITEM::GetCombinedPath ( MISTRING &  CombinedPath  )  const

Get the Combined Path.

This returns a string with the filepath and object path as as single string. Use SetCombinedPath to set an OBJITEM using a string of this format.

DEPRECATED const DESCRIPTOR& RVC::OBJITEM::GetDescriptor (  )  const [inline]

Get the RVC::DESCRIPTOR of the object represented by this instance.

Returns:
DESCRIPTOR instance containing the name and description of the object
Deprecated:
Use GetObjectDescriptor instead.

Definition at line 273 of file objitem.h.

MISTRING RVC::OBJITEM::GetDisplayString ( const CREDENTIALS *  Credentials = 0  )  const [inline]

Return string suitable for display.

String will consist of file name, separator and object name. GetToolTipString

Definition at line 288 of file objitem.h.

void RVC::OBJITEM::GetDisplayString ( MISTRING &  string,
const CREDENTIALS *  Credentials = 0 
) const

Get string suitable for display.

String will consist of file name, separator and object name. GetToolTipString

Parameters:
string  String returned

const FILEPATH& RVC::OBJITEM::GetFilePath (  )  const [inline]

Get the filepath.

Definition at line 293 of file objitem.h.

DEPRECATED const RVCGENINFO& RVC::OBJITEM::GetInfo ( const CREDENTIALS *  Credentials = 0  )  const [inline]

Get info.

Deprecated:
Avoid use of legacy RVCGENINFO structures.

Definition at line 310 of file objitem.h.

DEPRECATED RVCINODENUM RVC::OBJITEM::GetInode ( const CREDENTIALS *  Credentials = 0  )  const [inline]

Get the inode.

Deprecated:
Avoid use of INODENUM

Definition at line 299 of file objitem.h.

DEPRECATED const MIUNICODE* RVC::OBJITEM::GetObjectDescription ( const CREDENTIALS *  Credentials = 0  )  const [inline]

Get object description.

Definition at line 320 of file objitem.h.

const DESCRIPTOR& RVC::OBJITEM::GetObjectDescriptor ( const CREDENTIALS *  Credentials = 0  )  const [inline]

Get the RVC::DESCRIPTOR of the object represented by this instance.

Returns:
DESCRIPTOR instance containing the name and description of the object

Definition at line 330 of file objitem.h.

DEPRECATED const MIUNICODE* RVC::OBJITEM::GetObjectName ( const CREDENTIALS *  Credentials = 0  )  const [inline]

Get object name.

Definition at line 339 of file objitem.h.

ERRVALUE RVC::OBJITEM::GetObjectPath ( MISTRING &  ObjectPath,
const CREDENTIALS *  Credentials = 0 
) const [inline]

Get the Object Path.

Definition at line 348 of file objitem.h.

RVC::OBJTYPE RVC::OBJITEM::GetObjectType (  )  const

Get the object type.

bool RVC::OBJITEM::GetParent ( OBJITEM &  ParentObjItem,
const CREDENTIALS *  Credentials = 0 
) const

Get the parent object item for 'this'.

Returns:
'True' if the parent is valid, 'false' if not

MISTRING RVC::OBJITEM::GetToolTipString ( const CREDENTIALS *  Credentials = 0  )  const [inline]

Return standard "ToolTip" string for this item.

Returned string will contain multiple lines. GetDisplayString.

Definition at line 381 of file objitem.h.

void RVC::OBJITEM::GetToolTipString ( MISTRING &  string,
const CREDENTIALS *  Credentials = 0 
) const

Get standard "ToolTip" string for this item.

Returned string will contain multiple lines. GetDisplayString.

Parameters:
string  Tooltip string returned

bool RVC::OBJITEM::HasObjectDescription ( const CREDENTIALS *  Credentials = 0  )  const [inline]

Determine if has object description.

Definition at line 386 of file objitem.h.

bool RVC::OBJITEM::HasSameParent ( const OBJITEM &  rhs  )  const [inline]

Determine if the two OBJITEM's have the same parent object.

Definition at line 394 of file objitem.h.

bool RVC::OBJITEM::IniRead ( INIHANDLE  handle,
const char *  group,
const char *  field 
)

Read from .ini file.

Returns:
true if entry exists in .ini file, false if not.
Parameters:
handle  Ini Handle created by IniOpen()
group  Group to look for ini entry, App Name if =0
field  Field to read string from

void RVC::OBJITEM::IniWrite ( INIHANDLE  handle,
const char *  group,
const char *  field,
const CREDENTIALS *  Credentials = 0 
) const

Write to .ini file.

Parameters:
handle  Ini Handle created by IniOpen()
group  Group to write ini entry, App Name if =0
field  Field to write string to

bool RVC::OBJITEM::IsAssigned (  )  const

Determine if have both filepath and "object" assigned.

Does not determine if actually resolved to existing object.

bool RVC::OBJITEM::IsEqual ( const OBJITEM &  rhs,
const CREDENTIALS *  Credentials = 0 
) const [inline]

Is it the same?

Parameters:
rhs  Object to compare

Definition at line 420 of file objitem.h.

bool RVC::OBJITEM::IsExisting ( const CREDENTIALS *  Credentials = 0  )  const

Determine if item references actual existing object.

This should not be used in time-critical operations as it will actually open the file and verify that the object exists.

bool RVC::OBJITEM::IsFileOnly (  )  const [inline]

Determine if item references the file level.

Definition at line 436 of file objitem.h.

bool RVC::OBJITEM::IsLessThan ( const OBJITEM &  rhs  )  const

Determine if item is less than 'rhs' Needed for export of MILIST<OBJITEM> from dll.

bool RVC::OBJITEM::IsLessThanChild ( const OBJITEM &  rhs  )  const [inline]

Determine if item is less than 'rhs' according to child ordering.

Definition at line 446 of file objitem.h.

bool RVC::OBJITEM::IsNewRequest ( const CREDENTIALS *  Credentials = 0  )  const

Determine if item is built from a new object request from RVC::DlgGetObject().

bool RVC::OBJITEM::IsResolved (  )  const [inline]

Determine if has been resolved to specific existing object.

Definition at line 456 of file objitem.h.

bool RVC::OBJITEM::IsSkipRequest ( const CREDENTIALS *  Credentials = 0  )  const

Determine if item is built from a skip object request from RVC::DlgGetObject().

OBJITEM& RVC::OBJITEM::operator= ( const DESCRIPTOR &  Descriptor  ) 

Assignment.

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

Assignment.

Parameters:
rhs  Object to copy from

void RVC::OBJITEM::SetCombinedPath ( const MISTRING &  CombinedPath,
const CREDENTIALS *  Credentials = 0 
)

Set the Combined Path.

This sets up an ObjItem given a string encoded by GetCombinedPath

void RVC::OBJITEM::SetFilePath ( const FILEPATH &  filepath  )  [inline]

Set filename.

Definition at line 472 of file objitem.h.

DEPRECATED void RVC::OBJITEM::SetItem ( const FILEPATH &  filename,
RVCINODENUM  inode,
const CREDENTIALS *  Credentials = 0 
)

Set item from FILEPATH and object inode.

Deprecated:
Do not use legacy INODENUM
Parameters:
filename  File name
inode  Object inode

void RVC::OBJITEM::SetItem ( const FILEPATH &  filename,
const MISTRING &  ObjectPath 
)

Set item from FILEPATH and object path.

Parameters:
filename  File name
ObjectPath  Object path

DEPRECATED void RVC::OBJITEM::SetItem ( const FILEPATH &  filename,
const RVCGENINFO &  ginfo 
)

Set item from FILEPATH and RVCGENINFO.

Deprecated:
Avoid use of legacy RVCGENINFO structures.
Parameters:
filename  File name
ginfo  General info

void RVC::OBJITEM::SetItemToFile ( const FILEPATH &  filename,
const CREDENTIALS *  Credentials = 0 
)

Set item from FILEPATH only, must be an rvc file.

Parameters:
filename  File name

DEPRECATED void RVC::OBJITEM::SetObjectDescription ( const RVC::OBJECTDESC &  NewDesc  ) 

Set object description from RVC::OBJECTDESC.

Deprecated:
, Use SetObjectDescriptor()

void RVC::OBJITEM::SetObjectDescriptor ( const DESCRIPTOR &  NewDescriptor  ) 

Set object descriptor.

DEPRECATED void RVC::OBJITEM::SetObjectInfo ( const RVCGENINFO &  ginfo  ) 

Set object info from RVCGENINFO.

Deprecated:
Avoid use of legacy RVCGENINFO.
Parameters:
ginfo  General info

DEPRECATED void RVC::OBJITEM::SetObjectName ( const RVC::OBJECTNAME &  NewName  ) 

Set object name from RVC::OBJECTNAME.

Deprecated:
, Use SetObjectDescriptor()

void RVC::OBJITEM::SetObjectPath ( const MISTRING &  ObjectPath,
const CREDENTIALS *  Credentials = 0 
)

Set object path without clearing file path.

Parameters:
ObjectPath  Object path

void RVC::OBJITEM::SetObjectType ( UINT32  objtype  )  [inline]

Set object type if not bound to an object.

Parameters:
objtype  Object type

Definition at line 543 of file objitem.h.

void RVC::OBJITEM::SetSkipRequest (  ) 

Set item to be 'skip' request.

static void RVC::OBJITEM::SetupOutputList ( MILIST< OBJITEM > &  oobjlist,
const MILIST< OBJITEM > &  iobjlist,
const char *  source = 0 
) [static]

Setup output object item list corresponding to specified input object item list.

Parameters:
oobjlist  Output list
iobjlist  Input list
source  Value to use for "source" in object header, will use application name if null.

The documentation for this class was generated from the following file:
Generated on Thu Apr 26 04:49:08 2007 for TNTsdk by  doxygen 1.5.2