PoPrintMonitor Class Reference
[HardCopy]

HardCopy Abstract base class for print dialog box. More...

#include <HardCopy/editors/PoPrintMonitor.h>

Inheritance diagram for PoPrintMonitor:
SoXtComponent PoPrintCGMMonitor PoPrintHPGLMonitor PoPrintPSMonitor

List of all members.

Public Types

enum  PrintDialogMask {
  NO_PRINT_MASK = 0x00000000,
  UNIT = 0x00000001,
  GEOMETRY_WIDTH = 0x00000002,
  GEOMETRY_HEIGHT = 0x00000004,
  GEOMETRY_POS_X = 0x00000008,
  GEOMETRY_POS_Y = 0x00000010,
  GEOMETRY = GEOMETRY_WIDTH | GEOMETRY_HEIGHT | GEOMETRY_POS_X | GEOMETRY_POS_Y,
  ORIENTATION = 0x00000020,
  BORDER_WIDTH = 0x00000040,
  BORDER_COLOR = 0x00000080,
  BORDER = BORDER_WIDTH | BORDER_COLOR,
  BACKGROUND_SET = 0x00000100,
  BACKGROUND_COLOR = 0x00000200,
  BACKGROUND = BACKGROUND_SET | BACKGROUND_COLOR,
  NOMINAL_WIDTH = 0x00000400,
  TRANSLATION_METHOD = 0x00000800,
  LINE_END_STYLE = 0x00001000,
  LINE_JOIN_STYLE = 0x00002000,
  MITER_LIMIT = 0x00004000,
  PRINT_REGULATION,
  PEN_DESCRIPTION = 0x00008000,
  COLOR_PRIORITY = 0x00010000,
  ALL_PRINT_MASK
}
enum  Presentation {
  TOGGLE_FOLD,
  TOGGLE_UNFOLD,
  LABEL_UNFOLD
}
typedef void PoPrintMonitorCB (void *userData, PoPrintMonitor *action)

Public Member Functions

virtual void setPresentation (Presentation type)
Presentation getPresentation () const
void setPrintFilter (unsigned long inclusionMask, unsigned long exclusionMask)
void getPrintFilter (unsigned long &inclusionMask, unsigned long &exclusionMask) const
void setApply (SoNode *node)
void setApply (SoPath *path)
void setApply (const SoPathList &pathList, SbBool obeysRules=FALSE)
SoNONUNICODE void setFileName (char *fileName)
void setFileName (const SbString &fileName)
void setAction (SoVectorizeAction *action, SbBool isDestroyed)
virtual void show ()
virtual void hide ()

Detailed Description

HardCopy Abstract base class for print dialog box.

Class to build a dialog box which contains all elements to configure a printing. This abstract class uses SoVectorizeAction class parameters.

NOTE: This class does not exist in Open Inventor 10.0 and later.

Deprecated:

Deprecated since Open Inventor 9600
HardCopy editor classes are no longer supported.

Member Typedef Documentation

typedef void PoPrintMonitor::PoPrintMonitorCB(void *userData, PoPrintMonitor *action)

Member Enumeration Documentation

Enumerator:
TOGGLE_FOLD 
TOGGLE_UNFOLD 
LABEL_UNFOLD 
Enumerator:
NO_PRINT_MASK 
UNIT 
GEOMETRY_WIDTH 
GEOMETRY_HEIGHT 
GEOMETRY_POS_X 
GEOMETRY_POS_Y 
GEOMETRY 

Family mask.

GEOMETRY is a family mask thus: GEOMETRY = GEOMETRY_WITH | ... | GEOMETRY_POS_Y

ORIENTATION 
BORDER_WIDTH 
BORDER_COLOR 
BORDER 

Family mask.

BACKGROUND_SET 
BACKGROUND_COLOR 
BACKGROUND 

Family mask.

NOMINAL_WIDTH 
TRANSLATION_METHOD 
LINE_END_STYLE 
LINE_JOIN_STYLE 
MITER_LIMIT 
PRINT_REGULATION 

Family mask.

PEN_DESCRIPTION 
COLOR_PRIORITY 
ALL_PRINT_MASK 

Family mask.


Member Function Documentation

Presentation PoPrintMonitor::getPresentation (  )  const

Gets the presentation of the editor.

(TOGGLE_FOLD by default).

void PoPrintMonitor::getPrintFilter ( unsigned long &  inclusionMask,
unsigned long &  exclusionMask 
) const

Gets editing filters defining which print attributes will be displayed in the dialog box.

(By default inclusionMask = ALL_PRINT_MASK and exclusionMask = NO_PRINT_MASK).

virtual void PoPrintMonitor::hide (  )  [virtual]

This hides the component.

Reimplemented from SoXtComponent.

void PoPrintMonitor::setAction ( SoVectorizeAction action,
SbBool  isDestroyed 
)

Replaces the old action with a new action and updates the dialog box.

Be careful, if the application destroys the action, the dialog box will not work. If the application specifies isDestroyed TRUE, the dialog box will destroy the action, otherwise the application has to destroy the action after the dialog box is destroyed.

void PoPrintMonitor::setApply ( const SoPathList pathList,
SbBool  obeysRules = FALSE 
)

Sets apply function to a pathList.

(cf apply method of SoVectorizeAction).

void PoPrintMonitor::setApply ( SoPath path  ) 

Sets apply function to a path.

(cf apply method of SoVectorizeAction).

void PoPrintMonitor::setApply ( SoNode node  ) 

Sets apply function to a node.

(cf apply method of SoVectorizeAction).

void PoPrintMonitor::setFileName ( const SbString fileName  ) 

Sets the file name for the output.

SoNONUNICODE void PoPrintMonitor::setFileName ( char *  fileName  ) 

Sets the file name for the output.

Non Unicode List:
This function should not be used in a Unicode application.
virtual void PoPrintMonitor::setPresentation ( Presentation  type  )  [virtual]

Sets the presentation of the editor.

(TOGGLE_FOLD by default).

void PoPrintMonitor::setPrintFilter ( unsigned long  inclusionMask,
unsigned long  exclusionMask 
)

Gets editing filters defining which print attributes will be displayed in the dialog box.

(By default inclusionMask = ALL_PRINT_MASK and exclusionMask = NO_PRINT_MASK).

virtual void PoPrintMonitor::show (  )  [virtual]

This shows the component.

Reimplemented from SoXtComponent.


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

Open Inventor Toolkit reference manual, generated on 15 May 2022
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/