PlugInPath Class Reference

Represents a pathname object that the user has requested that all plug-ins be loaded in from. More...

#include <plugin.h>

Inheritance diagram for PlugInPath:

ListItem CCObject SimpleCCObject List of all members.

Public Member Functions

 PlugInPath (const PathName &NewPath, INT32 ID, BOOL IsHidden=FALSE)
 Create a new plug-in pathname list item from the given pathname.
PathName GetPathName () const
String_256 GetPathNameAsString () const
INT32 GetPathNameID ()
BOOL IsHidden ()

Protected Attributes

PathName m_Path
INT32 m_PathNameID
BOOL m_IsHidden

Detailed Description

Represents a pathname object that the user has requested that all plug-ins be loaded in from.

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
9/12/96
See also:
PlugInPathList;

Definition at line 206 of file plugin.h.


Constructor & Destructor Documentation

PlugInPath::PlugInPath const PathName NewPath,
INT32  ID,
BOOL  IsHidden = FALSE
 

Create a new plug-in pathname list item from the given pathname.

Author:
Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
Date:
9/12/96
Parameters:
Path - the pathname to put in the list. [INPUTS] ID - the ID a plug-in item uses to associate itself with a pathname IsHidden - the pathname is not one added by the user (Defaults to FALSE)
See also:
PlugInPathList;

Definition at line 235 of file plugin.cpp.

00236 {
00237     // Initialise our class variables to these specified values.
00238     m_Path = NewPath;
00239     m_PathNameID = ID;
00240     m_IsHidden = IsHidden;
00241 }


Member Function Documentation

PathName PlugInPath::GetPathName  )  const [inline]
 

Definition at line 214 of file plugin.h.

00214 { return m_Path; }

String_256 PlugInPath::GetPathNameAsString  )  const [inline]
 

Definition at line 215 of file plugin.h.

00215 { return m_Path.GetPath(); }

INT32 PlugInPath::GetPathNameID  )  [inline]
 

Definition at line 216 of file plugin.h.

00216 { return m_PathNameID; }

BOOL PlugInPath::IsHidden  )  [inline]
 

Definition at line 217 of file plugin.h.

00217 { return m_IsHidden; }


Member Data Documentation

BOOL PlugInPath::m_IsHidden [protected]
 

Definition at line 223 of file plugin.h.

PathName PlugInPath::m_Path [protected]
 

Definition at line 221 of file plugin.h.

INT32 PlugInPath::m_PathNameID [protected]
 

Definition at line 222 of file plugin.h.


The documentation for this class was generated from the following files:
Generated on Sat Nov 10 03:59:48 2007 for Camelot by  doxygen 1.4.4