#include <DbPlotSettingsValidator.h>

Inheritance diagram for OdDbPlotSettingsValidator:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbPlotSettingsValidator)

virtual OdResult	setPlotCfgName (OdDbPlotSettings *pPlotSettings, const OdString &plotDeviceName, const OdString &mediaName=OdString::kEmpty)=0

virtual OdResult	setCanonicalMediaName (OdDbPlotSettings *pPlotSettings, const OdString &mediaName)=0

virtual OdResult	setPlotOrigin (OdDbPlotSettings *pPlotSettings, double xCoordinate, double yCoordinate)=0

virtual OdResult	setPlotPaperUnits (OdDbPlotSettings *pPlotSettings, const PlotPaperUnits plotPaperUnits)=0

virtual OdResult	setPlotRotation (OdDbPlotSettings *pPlotSettings, const PlotRotation plotRotation)=0

virtual OdResult	setPlotCentered (OdDbPlotSettings *pPlotSettings, bool plotCentered)=0

virtual OdResult	setPlotType (OdDbPlotSettings *pPlotSettings, const PlotType plotType)=0

virtual OdResult	setPlotWindowArea (OdDbPlotSettings *pPlotSettings, double xMin, double yMin, double xMax, double yMax)=0

virtual OdResult	setPlotViewName (OdDbPlotSettings *pPlotSettings, const OdString &plotViewName)=0

virtual OdResult	setUseStandardScale (OdDbPlotSettings *pPlotSettings, bool useStandardScale)=0

virtual OdResult	setCustomPrintScale (OdDbPlotSettings *pPlotSettings, double numerator, double denominator)=0

virtual OdResult	setCurrentStyleSheet (OdDbPlotSettings *pPlotSettings, const OdString &currentStyleSheet)=0

virtual OdResult	setStdScaleType (OdDbPlotSettings *pPlotSettings, const StdScaleType stdScaleType)=0

virtual OdResult	setStdScale (OdDbPlotSettings *pPlotSettings, double standardScale)=0

virtual OdString	getLocaleMediaName (OdDbPlotSettings *pPlotSettings, const OdString &canonicalName)=0

virtual OdString	getLocaleMediaName (OdDbPlotSettings *pPlotSettings, int mediaIndex)=0

virtual OdResult	setClosestMediaName (OdDbPlotSettings *pPlotSettings, double paperWidth, double paperHeight, const PlotPaperUnits plotPaperUnits, bool matchPrintableArea)=0

virtual OdResult	recalculatePlotData (OdDbPlotSettings *pPlotSet)=0

virtual OdResult	setZoomToPaperOnUpdate (OdDbPlotSettings *pPlotSettings, bool zoomToPaperOnUpdate)=0

virtual OdResult	setDefaultPlotConfig (OdDbPlotSettings *pPlotSettings)=0

virtual void	plotDeviceList (OdArray< OdString > &deviceList)=0

virtual OdResult	canonicalMediaNameList (OdDbPlotSettings *pPlotSettings, OdArray< OdString > &mediaList)=0

virtual OdResult	plotStyleSheetList (OdArray< OdString > &styleList)=0

Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()

	OdRxObject ()

virtual	~OdRxObject ()

virtual OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () const

virtual void	addRef ()=0

virtual void	release ()=0

virtual long	numRefs () const

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

virtual void	copyFrom (const OdRxObject *pSource)

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Protected Member Functions
virtual void	plotDeviceList (OdArray< const OdChar * > &deviceList)=0

virtual OdResult	canonicalMediaNameList (OdDbPlotSettings pPlotSettings, OdArray< const OdChar > &mediaList)=0

virtual OdResult	plotStyleSheetList (OdArray< const OdChar * > &styleList)=0

virtual void	refreshLists (OdDbPlotSettings *pPlotSettings)=0

Friends
struct	Helper

class	CExport2PDFDialog

TOOLKIT_EXPORT void	fxRefreshLists (OdDbPlotSettingsValidator p, OdDbPlotSettings pPlotSettings)

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Detailed Description

This class defines access methods that validate data for OdDbPlotSettings objects prior to setting the data on the objects.

See also: TD_Db

Remarks: Plot device and style lists should be refreshed with refreshLists() prior to using the other methods in this class, in case any plot devices, PC3 files, or plot style tables were changed after starting your application.

Definition at line 56 of file DbPlotSettingsValidator.h.

Member Function Documentation

◆ canonicalMediaNameList() [1/2]

virtual OdResult OdDbPlotSettingsValidator::canonicalMediaNameList	(	OdDbPlotSettings *	pPlotSettings,
		OdArray< const OdChar * > &	mediaList
	)

protectedpure virtual

Returns an array canonical (locale-independent) media names for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
mediaList	[out] Receives the media name list.

Remarks: Plot device and style lists should be refreshed with refreshLists() prior to using the other methods in this class, in case any plot devices, PC3 files, or plot style tables were changed after starting your application.

◆ canonicalMediaNameList() [2/2]

virtual OdResult OdDbPlotSettingsValidator::canonicalMediaNameList	(	OdDbPlotSettings *	pPlotSettings,
		OdArray< OdString > &	mediaList
	)

pure virtual

◆ getLocaleMediaName() [1/2]

virtual OdString OdDbPlotSettingsValidator::getLocaleMediaName	(	OdDbPlotSettings *	pPlotSettings,
		const OdString &	canonicalName
	)

pure virtual

Returns the locale-dependent media name for the specified PlotSettings object and canonical media name or index.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
canonicalName	[out] Locale-independent media name.

Remarks: Plot device and style lists should be refreshed with refreshLists() prior to using the other methods in this class, in case any plot devices were added or removed after starting your application.

◆ getLocaleMediaName() [2/2]

virtual OdString OdDbPlotSettingsValidator::getLocaleMediaName	(	OdDbPlotSettings *	pPlotSettings,
		int	mediaIndex
	)

pure virtual

Returns the locale-dependent media name for the specified PlotSettings object and index.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
mediaIndex	[in] Media index.

◆ ODRX_DECLARE_MEMBERS()

OdDbPlotSettingsValidator::ODRX_DECLARE_MEMBERS ( OdDbPlotSettingsValidator )

◆ plotDeviceList() [1/2]

virtual void OdDbPlotSettingsValidator::plotDeviceList ( OdArray< const OdChar * > & deviceList )

protectedpure virtual

Returns an array of all available system printers and PC3 files.

Remarks: Plot device and style lists should be refreshed with refreshLists() prior to using the other methods in this class, in case any plot devices, PC3 files, or plot style tables were changed after starting your application.

Parameters

deviceList [out] Receives the plot device list.

◆ plotDeviceList() [2/2]

virtual void OdDbPlotSettingsValidator::plotDeviceList ( OdArray< OdString > & deviceList )

pure virtual

◆ plotStyleSheetList() [1/2]

virtual OdResult OdDbPlotSettingsValidator::plotStyleSheetList ( OdArray< const OdChar * > & styleList )

protectedpure virtual

◆ plotStyleSheetList() [2/2]

virtual OdResult OdDbPlotSettingsValidator::plotStyleSheetList ( OdArray< OdString > & styleList )

pure virtual

◆ recalculatePlotData()

virtual OdResult OdDbPlotSettingsValidator::recalculatePlotData ( OdDbPlotSettings * pPlotSet )

pure virtual

Returns an array of all available plot style tables.

Remarks: Plot device and style lists should be refreshed with refreshLists() prior to using the other methods in this class, in case any plot devices, PC3 files, or plot style tables were changed after starting your application.

Parameters

styleList [out] Receives the plot style list.

Implemented in OdDbPlotSettingsValidator2.

◆ refreshLists()

virtual void OdDbPlotSettingsValidator::refreshLists ( OdDbPlotSettings * pPlotSettings )

protectedpure virtual

Refreshes the plot device and style lists for the specified PlotSettings object.

Remarks: Plot device and style lists should be refreshed with refreshLists() prior to using the other methods in this class, in case any plot devices, PC3 files, or plot style tables were changed after starting your application.

Parameters

pPlotSettings [in] Pointer to the PlotSettings object.

◆ setCanonicalMediaName()

virtual OdResult OdDbPlotSettingsValidator::setCanonicalMediaName	(	OdDbPlotSettings *	pPlotSettings,
		const OdString &	mediaName
	)

pure virtual

Sets the canonical (locale-independent) media name for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
mediaName	[in] Canonical media name.

Remarks: The canonical media name is locale-independent.

See also: getLocaleMediaName()

Remarks: Canonical media names are case-sensitive.

◆ setClosestMediaName()

virtual OdResult OdDbPlotSettingsValidator::setClosestMediaName	(	OdDbPlotSettings *	pPlotSettings,
		double	paperWidth,
		double	paperHeight,
		const PlotPaperUnits	plotPaperUnits,
		bool	matchPrintableArea
	)

pure virtual

Sets the media name closest to the specified parameters for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
paperWidth	[in] Paper width.
paperHeight	[in] Paper height.
plotPaperUnits	[in] Plot paper units.
matchPrintableArea	[in] True to match against printable area or physical media size.

Remarks: The plot paper units determine the units of the margins, offsets, paper size, and drawing units.

plotPaperUnits must be one of the following:

Value Description kInches 0 Inches kMillimeters 1 Millimeters kPixels 2 Pixels

◆ setCurrentStyleSheet()

virtual OdResult OdDbPlotSettingsValidator::setCurrentStyleSheet	(	OdDbPlotSettings *	pPlotSettings,
		const OdString &	currentStyleSheet
	)

pure virtual

Sets the current style sheet for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
currentStyleSheet	[in] Name of current style sheet.

◆ setCustomPrintScale()

virtual OdResult OdDbPlotSettingsValidator::setCustomPrintScale	(	OdDbPlotSettings *	pPlotSettings,
		double	numerator,
		double	denominator
	)

pure virtual

Sets the custom print scale for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
numerator	[in] Receives the PaperSpace units.
denominator	[in] Receives the media units.

Remarks: The custom print scale always reflects the scale that this PlotSettings object will use to plot.

◆ setDefaultPlotConfig()

virtual OdResult OdDbPlotSettingsValidator::setDefaultPlotConfig ( OdDbPlotSettings * pPlotSettings )

pure virtual

Applies the default plot configuration settings to the specified PlotSettings object.

Parameters

pPlotSettings [in] Pointer to the PlotSettings object.

◆ setPlotCentered()

virtual OdResult OdDbPlotSettingsValidator::setPlotCentered	(	OdDbPlotSettings *	pPlotSettings,
		bool	plotCentered
	)

pure virtual

Controls the centering of the plot for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
plotCentered	[in] Plot centered.

◆ setPlotCfgName()

virtual OdResult OdDbPlotSettingsValidator::setPlotCfgName	(	OdDbPlotSettings *	pPlotSettings,
		const OdString &	plotDeviceName,
		const OdString &	mediaName = `OdString::kEmpty`
	)

pure virtual

Sets the plot device and media names for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
plotDeviceName	[in] Name of the system printer or PC3 file.
mediaName	[in] Media name.

Remarks: (plotDeviceName == none_device) requires (mediaName == none_user_media)

◆ setPlotOrigin()

virtual OdResult OdDbPlotSettingsValidator::setPlotOrigin	(	OdDbPlotSettings *	pPlotSettings,
		double	xCoordinate,
		double	yCoordinate
	)

pure virtual

Sets the plot origin offset for the specified PlotSettings object.

Parameters

xCoordinate	[out] X-coordinate of the origin offset.
yCoordinate	[out] Y-coordinate of the origin offset.

Remarks: The plot origin offset is measured with respect to the plot margin.; All distances are returned in millimeters, regardless of the drawing units.

◆ setPlotPaperUnits()

virtual OdResult OdDbPlotSettingsValidator::setPlotPaperUnits	(	OdDbPlotSettings *	pPlotSettings,
		const PlotPaperUnits	plotPaperUnits
	)

pure virtual

Sets the plot paper units for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
plotPaperUnits	[in] Plot paper units.

Remarks: The plot paper units determine the units of the margins, offsets, paper size, and drawing units.

plotPaperUnits must be one of the following:

Value Description kInches 0 Inches kMillimeters 1 Millimeters kPixels 2 Pixels

◆ setPlotRotation()

virtual OdResult OdDbPlotSettingsValidator::setPlotRotation	(	OdDbPlotSettings *	pPlotSettings,
		const PlotRotation	plotRotation
	)

pure virtual

Sets the plot rotation for specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
plotRotation	[in] Plot rotation.

Remarks: plotRotation must be one of the following:

Value Description k0degrees 0 No rotation k90degrees 1 90° CCW k180degrees 2 Inverted° k270degrees 3 90° CW

◆ setPlotType()

virtual OdResult OdDbPlotSettingsValidator::setPlotType	(	OdDbPlotSettings *	pPlotSettings,
		const PlotType	plotType
	)

pure virtual

Sets the plot type for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
plotType	[in] Plot type.

Remarks: plotType must be one of the following:

Value Description kDisplay 0 Display kExtents 1 Extents kLimits 2 Limits kView 3 View kWindow 4 Window kLayout 5 Layout

◆ setPlotViewName()

virtual OdResult OdDbPlotSettingsValidator::setPlotViewName	(	OdDbPlotSettings *	pPlotSettings,
		const OdString &	plotViewName
	)

pure virtual

Sets the plot view name for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
plotViewName	[in] Plot view name.

Remarks: This string specifies the named view to be plotted if and only if plotType == kView.

◆ setPlotWindowArea()

virtual OdResult OdDbPlotSettingsValidator::setPlotWindowArea	(	OdDbPlotSettings *	pPlotSettings,
		double	xMin,
		double	yMin,
		double	xMax,
		double	yMax
	)

pure virtual

Sets the corners of the plot window area for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
xMin	[in] X-coordinate of the lower-left corner.
yMin	[in] Y-coordinate of the lower-left corner.
xMax	[in] X-coordinate of the upper-right corner.
yMax	[in] Y-coordinate of the upper-right corner.

Remarks: The corners define the area to be plotted if and only if plotType == kWindow.

◆ setStdScale()

virtual OdResult OdDbPlotSettingsValidator::setStdScale	(	OdDbPlotSettings *	pPlotSettings,
		double	standardScale
	)

pure virtual

Sets the standard scale, as a floating point value, for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
standardScale	[in] Standard scale.

◆ setStdScaleType()

virtual OdResult OdDbPlotSettingsValidator::setStdScaleType	(	OdDbPlotSettings *	pPlotSettings,
		const StdScaleType	stdScaleType
	)

pure virtual

Sets the standard scale type for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
stdScaleType	[in] Name of current style sheet.

Remarks: stdScaleType must be one of the of the following

Value Scale kScaleToFit 0 Scaled to Fit k1_128in_1ft 1 1/128=1' k1_64in_1ft 2 1/64=1' k1_32in_1ft 3 1/32=1' k1_16in_1ft 4 1/16=1' k3_32in_1ft 5 3/32=1' k1_8in_1ft 6 1/8=1' k3_16in_1ft 7 3/16=1' k1_4in_1ft 8 1/4=1' k3_8in_1ft 9 3/8=1' k1_2in_1ft 10 1/2=1' k3_4in_1ft 11 3/4=1' k1in_1ft 12 1=1' k3in_1ft 13 3=1' k6in_1ft 14 6=1' k1ft_1ft 15 1'=1' k1_1 16 1:1 k1_2 17 1:2 k1_4 18 1:4 k1_5 19 1:5 k1_8 20 1:8 k1_10 21 1:10 k1_16 22 1:16 k1_20 23 1:20 k1_30 24 1:30 k1_40 25 1:40 k1_50 26 1:50 k1_100 27 1:100 k2_1 28 2:1 k4_1 29 4:1 k8_1 30 8:1 k10_1 31 10:1 k100_1 32 100:1 k1000_1 33 1000:1 k1and1_2in_1ft 34 1.5"=1'

◆ setUseStandardScale()

virtual OdResult OdDbPlotSettingsValidator::setUseStandardScale	(	OdDbPlotSettings *	pPlotSettings,
		bool	useStandardScale
	)

pure virtual

Controls the use of a standard scale for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
useStandardScale	[in] Use standard scale.

◆ setZoomToPaperOnUpdate()

virtual OdResult OdDbPlotSettingsValidator::setZoomToPaperOnUpdate	(	OdDbPlotSettings *	pPlotSettings,
		bool	zoomToPaperOnUpdate
	)

pure virtual

Controls the Zoom to Paper on Update setting for the specified PlotSettings object.

Parameters

pPlotSettings	[in] Pointer to the PlotSettings object.
zoomToPaperOnUpdate	[in] Zoom to Paper on Update.

Friends And Related Function Documentation

◆ CExport2PDFDialog

friend class CExport2PDFDialog

friend

Definition at line 426 of file DbPlotSettingsValidator.h.

◆ fxRefreshLists

TOOLKIT_EXPORT void fxRefreshLists	(	OdDbPlotSettingsValidator *	p,
		OdDbPlotSettings *	pPlotSettings
	)

friend

Description: This function MUST NOT be used outside of ODA.

◆ Helper

friend struct Helper

friend

Definition at line 333 of file DbPlotSettingsValidator.h.

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

DbPlotSettingsValidator.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ canonicalMediaNameList() [1/2]

◆ canonicalMediaNameList() [2/2]

◆ getLocaleMediaName() [1/2]

◆ getLocaleMediaName() [2/2]

◆ ODRX_DECLARE_MEMBERS()

◆ plotDeviceList() [1/2]

◆ plotDeviceList() [2/2]

◆ plotStyleSheetList() [1/2]

◆ plotStyleSheetList() [2/2]

◆ recalculatePlotData()

◆ refreshLists()

◆ setCanonicalMediaName()

◆ setClosestMediaName()

◆ setCurrentStyleSheet()

◆ setCustomPrintScale()

◆ setDefaultPlotConfig()

◆ setPlotCentered()

◆ setPlotCfgName()

◆ setPlotOrigin()

◆ setPlotPaperUnits()

◆ setPlotRotation()

◆ setPlotType()

◆ setPlotViewName()

◆ setPlotWindowArea()

◆ setStdScale()

◆ setStdScaleType()

◆ setUseStandardScale()

◆ setZoomToPaperOnUpdate()

Friends And Related Function Documentation

◆ CExport2PDFDialog

◆ fxRefreshLists

◆ Helper