[ First ]  [ Previous ]  [ Next ]  [ Last ]  [ Manuals ]

 

LSingleDoc



Overview:

LSingleDoc is a PowerPlant class that is used as a simple extension of LDocument. You must derive your own methods from this object ot provide functionality.

Methods :

The methods in this class are:

 

LSingleDoc()  
~LSingleDoc()  
AllowSubRemoval()  
GetDescriptor()  
GetFile()  
GetWindow()  
MakeCurrent()  
UsesFileSpec()  

Data Members:

The data members in this class are:

 

mWindow  
mFile  

Source files:

(Commander Classes)

LSingleDoc.h

LSingleDoc.cp

See also:

LCommander

LDocument

LSingleDoc()

Purpose:

The constructor creates the object.

Access :

Public

Prototype:

LSingleDoc();

LSingleDoc( LCommander	*inSuper );
Parameters:

An LCommander super object.

~LSingleDoc()

Purpose:

The destructor destroys the object.

Access :

Virtual, Public

Prototype:

virtual ~LSingleDoc();

AllowSubRemoval()

Purpose:

This is an override of AllowSubRemoval() in LCommander.

GetDescriptor()

Purpose:

This is an override of GetDescriptor() in LDocument.

GetFile()

Purpose:

This returns the file pointer held in mFile.

Access :

Public

Prototype:

LFile*	GetFile() const;
Parameters:

None

Return:

The file pointer.

GetWindow()

Purpose:

This method returns the window pointer held in mWindow.

Access :

Public

Prototype:

LWindow*	GetWindow() const;
Parameters:

None

Return:

None

MakeCurrent()

Purpose:

Make this Document the current one by selecting its Window.

Access :

Virtual, Public

Prototype:

virtual void MakeCurrent();
Parameters:

None

Return:

None

UsesFileSpec()

Purpose:

Returns whether the Document's File has the given FSSpec.

Access :

Virtual, Public

Prototype:

virtual Boolean UsesFileSpec(

	const FSSpec	&inFileSpec ) const;
Parameters:

A FSSpec for the file.

Return:

Return true if it has the FSSpec.

mWindow

Purpose:

The window pointer.

Access :

Protected

Prototype:

LWindow		*mWindow;

mFile

Purpose:

The file pointer storage.

Access :

Protected

Prototype:

LFile	*mFile;

 


[ First ]  [ Previous ]  [ Next ]  [ Last ]  [ Manuals ]

Visit the Metrowerks website at: http://www.metrowerks.com
For assistance contact Metrowerks Technical Support at: cw_support@metrowerks.com
Copyright © 2000, Metrowerks Corp. All rights reserved.

Last updated: July 21, 2000