Public Member Functions | List of all members
IPlotterFormList Struct Referenceabstract

List of Plotter paper sizes. More...

#include <IPlotter.h>

Public Member Functions

virtual int GetNumForms () const =0
 Gets the number of forms defined for the plotter. More...
 
virtual void SetCurrentForm (int formListIndex)=0
 Sets the current form in the form list. More...
 
virtual IPlotterFormP GetCurrentForm () const =0
 Gets the current form in the form list. May be NULL. More...
 
virtual int GetCurrentFormIndex () const =0
 Gets the index of the current form in the form list. More...
 
virtual int GetDefaultFormIndex () const =0
 Gets the index of the default form in the form list. More...
 
virtual IPlotterFormP GetFormByIndex (int formListIndex) const =0
 Gets information about a particular form index. More...
 
virtual IPlotterFormP GetFormByName (WCharCP searchName, int *formListIndexP=0) const =0
 Gets information about a particular form name. More...
 
virtual IPlotterFormP GetFormByPaperSizeNumber (int searchPaperSizeNumber, int *formListIndexP=0) const =0
 Gets information about a particular form paper size number. More...
 
virtual IPlotterFormP AppendForm ()=0
 Creates a new form in the list. More...
 
virtual void RemoveForm (int formListIndex)=0
 Removes a form from the list. More...
 
virtual void RemoveAllForms ()=0
 Removes all forms from the list. More...
 

Detailed Description

List of Plotter paper sizes.

Member Function Documentation

virtual IPlotterFormP AppendForm ( )
pure virtual

Creates a new form in the list.

virtual IPlotterFormP GetCurrentForm ( ) const
pure virtual

Gets the current form in the form list. May be NULL.

virtual int GetCurrentFormIndex ( ) const
pure virtual

Gets the index of the current form in the form list.

virtual int GetDefaultFormIndex ( ) const
pure virtual

Gets the index of the default form in the form list.

Will be -1 if no default form defined.

virtual IPlotterFormP GetFormByIndex ( int  formListIndex) const
pure virtual

Gets information about a particular form index.

Parameters
[in]formListIndexIndex into the form list, or -1 for current form.
virtual IPlotterFormP GetFormByName ( WCharCP  searchName,
int *  formListIndexP = 0 
) const
pure virtual

Gets information about a particular form name.

Parameters
[in]searchNameForm name to search for.
[out]formListIndexPReturned index into the form list of new form (may be NULL).
virtual IPlotterFormP GetFormByPaperSizeNumber ( int  searchPaperSizeNumber,
int *  formListIndexP = 0 
) const
pure virtual

Gets information about a particular form paper size number.

Parameters
[in]searchPaperSizeNumberPaper size number to search for.
[out]formListIndexPReturned index into the form list of new form (may be NULL).
virtual int GetNumForms ( ) const
pure virtual

Gets the number of forms defined for the plotter.

virtual void RemoveAllForms ( )
pure virtual

Removes all forms from the list.

virtual void RemoveForm ( int  formListIndex)
pure virtual

Removes a form from the list.

Parameters
[in]formListIndexIndex into the form list, or -1 for current form.
virtual void SetCurrentForm ( int  formListIndex)
pure virtual

Sets the current form in the form list.

Parameters
[in]formListIndexIndex into the form list, or -1 for current form.

The documentation for this struct was generated from the following file:

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.