RasterPagerShell Class Reference
[Plug-In Shells]

#include <RasterPagerShell.h>

Inheritance diagram for RasterPagerShell:

List of all members.

Public Member Functions
	RasterPagerShell ()
	~RasterPagerShell ()
bool	getOutputSpecification (PlugInArgList *&pArgList)
bool	serialize (SessionItemSerializer &serializer) const

---

Detailed Description

Definition at line 19 of file RasterPagerShell.h.

---

Constructor & Destructor Documentation

RasterPagerShell::RasterPagerShell

(

)

Creates a raster pager plug-in.

The constructor sets the plug-in type to PlugInManagerServices::RasterPagerType(), sets the plug-in to allow multiple instances, and to not be destroyed after execution.

See also:

getType(), areMultipleInstancesAllowed(), isDestroyedAfterExecute()

RasterPagerShell::~RasterPagerShell

(

)

Destroys the raster pager plug-in.

---

Member Function Documentation

bool RasterPagerShell::getOutputSpecification

(

PlugInArgList *&

pArgList

)

[virtual]

Retrieves the plug-in output parameters.

This method queries the plug-in for its output parameters that are created during execution. The output arguments may be different in interactive mode and batch mode.

Parameters:

pArgList

A plug-in arg list pointer that is set to a created output argument list specifying the plug-in output parameters. NULL is a valid pointer value if the plug-in does not provide any output arguments.

Returns:

Returns true if the output parameter argument list was successfully created. If the plug-in does not provide output arguments, true is returned, but the given plug-in arg list pointer may be NULL.

See also:

PlugInArgList

Default Implementation:

The default implementation does not set any args in the arg list and returns true.

Implements Executable.

Reimplemented in CachedPager.

bool RasterPagerShell::serialize

(

SessionItemSerializer &

serializer

)

const [virtual]

The default pager session serialization method.

Since pagers don't know enough to recreate and restore themselves on session load, they must be created by the RasterElement or another plug- in. The default method simply returns true, causing the session load to not recreate the pager.

Parameters:

serializer

The object to use to save the item as part of the current session.

Returns:

true if the item was successfully saved and false otherwise.

Reimplemented from PlugInShell.