PlugInPathList Class Reference

Holds a list of Pathnames that the PlugInManager will use to search for plug-ins. The list is set up by the user in the plug-ins options tab. More...

#include <plugin.h>

Inheritance diagram for PlugInPathList:

List of all members.

Public Member Functions
	PlugInPathList ()
	Constructor for the list of pathnames to parse plug-ins for.
	~PlugInPathList ()
	Destroy the list of pathnames to parse plug-ins for.
PlugInPath *	GetFirstPath ()
	Finds the first pathname in the list of plug-in pathnames. When searching the pathname list, you MUST use these form of the list classes GetHead/GetNext as otherwise you will get unknown effects.
PlugInPath *	GetNextPath (const PlugInPath *pCurrentItem)
	Finds the next pathname in the list of plug-in pathnames. When searching the pathname list, you MUST use these form of the list classes GetHead/GetNext as otherwise you will get unknown effects.
PlugInPath *	AddPathName (const PathName &NewPath, BOOL IsHidden=FALSE)
	Add a new pathname to the list of plug-in pathnames. Hidden pathnames are ones not added by the user but are the sub-directories of the user added ones.
BOOL	DeletePathName (const PathName &OldPath)
	Delete a pathname from the list of plug-in pathnames.
BOOL	RemoveHiddenItems ()
	Removes all hidden items, i.e. ones not added by the user, from the list of pathnames.
Protected Attributes
INT32	m_IDCounter

---

Detailed Description

Holds a list of Pathnames that the PlugInManager will use to search for plug-ins. The list is set up by the user in the plug-ins options tab.

Author:

Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>

Date:

9/12/96

See also:

PlugInPath;

Definition at line 238 of file plugin.h.

---

Constructor & Destructor Documentation

PlugInPathList::PlugInPathList (   )

Constructor for the list of pathnames to parse plug-ins for. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 10/12/96 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - See also: PlugInPath Definition at line 260 of file plugin.cpp. { m_IDCounter = 0; }

PlugInPathList::~PlugInPathList (   )

Destroy the list of pathnames to parse plug-ins for. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 9/12/96 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - See also: PlugInPath Definition at line 279 of file plugin.cpp. { // Destroy the list of pathnames which we may have /* PlugInPath* pPath = (PlugInPath *)GetHead(); while (pPath) { delete pPath; // Try the next pathname in the list pPath = (PlugInPath *)GetNext(pPath); } */ DeleteAll(); }

---

Member Function Documentation

PlugInPath * PlugInPathList::AddPathName (  const PathName &  NewPath, BOOL  IsHidden = FALSE )

Add a new pathname to the list of plug-in pathnames. Hidden pathnames are ones not added by the user but are the sub-directories of the user added ones. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 9/12/96 Parameters: NewPath  - the new pathname to put in the list. [INPUTS] IsHidden - the pathname is not one added by the user (Defaults to FALSE) Returns: Pointer to the newly added pathname, or NULL if out of memory => ERROR1 Errors: Out of memory => ERROR1 See also: PlugInPath Definition at line 415 of file plugin.cpp. { PlugInPath *pPlugPath = new PlugInPath(NewPath, m_IDCounter, IsHidden); // Increment our counter which a plug-in uses to associate itself with a pathname m_IDCounter++; // Check for out of memory if (pPlugPath == NULL) return NULL; // Add to the list and return success AddTail(pPlugPath); return pPlugPath; }

BOOL PlugInPathList::DeletePathName (  const PathName &  OldPath  )

Delete a pathname from the list of plug-in pathnames. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 9/12/96 Parameters: OldPath  - the pathname to delete from the list. [INPUTS] Returns: True if deleted ok, False otherwise. See also: PlugInPath Definition at line 444 of file plugin.cpp. { String_256 OldPathStr = OldPath.GetPath(); PlugInPath* pPath = (PlugInPath *)GetHead(); while (pPath) { PathName Path = pPath->GetPathName(); if (Path.GetPath() == OldPathStr) { RemoveItem(pPath); // remove item returns NULL if problem if (pPath == NULL) return FALSE; delete pPath; return TRUE; } // Try the next pathname in the list pPath = (PlugInPath *)GetNext(pPath); } // Failed to find the path in the list return FALSE; }

PlugInPath * PlugInPathList::GetFirstPath (   )

Finds the first pathname in the list of plug-in pathnames. When searching the pathname list, you MUST use these form of the list classes GetHead/GetNext as otherwise you will get unknown effects. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 9/1/97 Returns: Pointer to the first PlugInPath or NULL if there are none. See also: GetNextPath Definition at line 308 of file plugin.cpp. { // Get the real first item, if there is one PlugInPath * pPath = (PlugInPath * ) GetHead(); // While there is an item and it is hidden then search for the next one in the list while (pPath && pPath->IsHidden()) { pPath = (PlugInPath * ) GetNext(pPath); } return pPath; }

PlugInPath * PlugInPathList::GetNextPath (  const PlugInPath *  pCurrentItem  )

Finds the next pathname in the list of plug-in pathnames. When searching the pathname list, you MUST use these form of the list classes GetHead/GetNext as otherwise you will get unknown effects. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 9/1/97 Returns: Pointer to the first PlugInPath or NULL if there are none. See also: GetNextPath Definition at line 335 of file plugin.cpp. { ERROR3IF(pCurrentItem == NULL,"GetNextPath has been given a null current item"); if (pCurrentItem == NULL) return NULL; // Get the real next item, if there is one PlugInPath * pPath = (PlugInPath * ) GetNext(pCurrentItem); // While there is an item and it is hidden then search for the next one in the list while (pPath && pPath->IsHidden()) { pPath = (PlugInPath * ) GetNext(pPath); } return pPath; }

BOOL PlugInPathList::RemoveHiddenItems (   )

Removes all hidden items, i.e. ones not added by the user, from the list of pathnames. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 9/1/97 Returns: True if completed succesfully, False otherwise. Definition at line 364 of file plugin.cpp. { // Go through all the paths in the list and remove all those with the hidden // attribute set. PlugInPath* pPath = (PlugInPath *)GetHead(); while (pPath) { if (pPath->IsHidden()) { // The item is hidden so remove it // First, find the next item, if there is one PlugInPath* pNextPath = (PlugInPath *)GetNext(pPath); RemoveItem(pPath); // remove item returns NULL if problem if (pPath == NULL) return FALSE; // remove the old path item from memory delete pPath; // move to considering the next item pPath = pNextPath; } else { // Try the next pathname in the list pPath = (PlugInPath *)GetNext(pPath); } } return TRUE; }

---

Member Data Documentation

INT32 PlugInPathList::m_IDCounter [protected]

Definition at line 257 of file plugin.h.

---

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

• Kernel/plugin.h (r1785/r1282)
• Kernel/plugin.cpp (r1785/r751)

---