General printing system classes, functions, and data types. More...
Classes | |
struct | PrintStyleName |
Name and source file location of a print style. More... | |
struct | PlotPaperSizeInfo |
Printer paper size. More... | |
struct | PlotFileSpec |
Represents a file specification in the printing system. More... | |
struct | PlotPropValue |
Variant value container in a print property dictionary. More... | |
Typedefs | |
typedef bvector< PrintStyleName > & | PrintStyleNameListR |
typedef bvector < PlotPaperSizeInfo > | PlotPaperSizeList |
typedef bvector < PlotPaperSizeInfo > & | PlotPaperSizeListR |
typedef bmap< WString, PlotPropValue > | PlotPropertyMap |
typedef bmap< WString, PlotPropValue > * | PlotPropertyMapP |
typedef bmap< WString, PlotPropValue > const * | PlotPropertyMapCP |
typedef bmap< WString, PlotPropValue > & | PlotPropertyMapR |
typedef bmap< WString, PlotPropValue > const & | PlotPropertyMapCR |
Enumerations | |
enum | PlotUnits { Undefined = -1, Default = 0, m = 1, dm = 2, cm = 3, mm = 4, ft = 5, in = 6, dots = 7, tenthsmm = 8 } |
Printing system units. More... | |
enum | PlotAreaMode { View = 0, Fence = 1, Sheet = 2 } |
Printing system area mode. More... | |
enum | PlotDestination { Undefined = -1, ToDevice = 0, ToPlotFile = 1, ToMetaFile = 2, ToIpserver = 3 } |
Printing system destination. More... | |
enum | PlotOrientation { Undefined = -1, Portrait = 0, Landscape = 1 } |
Printing system orientation. More... | |
enum | PlotPropValueType { Undefined = 0, Integer = 1, Double = 2, String = 3 } |
Printing system property value type. More... | |
enum | PlotError { NoError = 0, Internal = 255, DiskFull = 254, UserAbort = 253, Malloc = 252, OpenFile = 251, WriteFile = 250, CreateFile = 249, PermissionDenied = 248, InvalidScale = 247, IllegalWrite = 246, Timeout = 245 } |
Printing system error code. More... | |
Functions | |
PlotFileSpec () | |
Default constructor. More... | |
PlotFileSpec (WStringCR ufs) | |
Constructs a PlotFileSpec from a universal file specification. More... | |
PlotFileSpec (WStringCR ufs, bool isHfs) | |
Constructs a PlotFileSpec from a universal file specification, while also optionally setting the host file specification to the same value. More... | |
PlotFileSpec (WCharCP ufs) | |
Constructs a PlotFileSpec from a universal file specification. More... | |
PlotFileSpec (WCharCP ufs, bool isHfs) | |
Constructs a PlotFileSpec from a universal file specification, while also optionally setting the host file specification to the same value. More... | |
PlotFileSpec (DgnDocumentCP document) | |
Constructs a PlotFileSpec from a DgnDocument. More... | |
PlotFileSpec (DgnFolderCP folder) | |
Constructs a PlotFileSpec from a DgnDocument. More... | |
PlotFileSpec (PlotFileSpecCR source) | |
Copy constructor. More... | |
PlotFileSpecR | operator= (PlotFileSpecCR source) |
Assigns from another PlotFileSpec instance. More... | |
~PlotFileSpec () | |
Destructor. More... | |
BeFileNameCR | Ufs () const |
Gets the universal file specification, without any embedded suffix. More... | |
BeFileName | GetUfs (bool includeEmbeddedSuffix=false) const |
Gets the universal file specification. More... | |
void | SetUfs (WCharCP value) |
Sets the universal file specification. More... | |
void | SetUfsOnly (WStringCR value) |
Sets the universal file specification without clearing anything. More... | |
void | SetUfsAndHfs (WCharCP value) |
Sets both the universal and host file specifications. More... | |
BeFileNameCR | Hfs () const |
Gets the host file specification, without any embedded suffix. More... | |
BeFileName | GetHfs (bool includeEmbeddedSuffix=false) const |
Gets the host file specification. More... | |
void | SetHfs (WCharCP value) |
Sets the host file specification. More... | |
void | ClearHfs () |
Clears the host file specification. More... | |
BeFileNameCR | HfsOrUfs () const |
Gets the host file specification if defined, otherwise the universal file specification. More... | |
BeFileName | GetHfsOrUfs (bool includeEmbeddedSuffix=false) const |
Gets the host file specification if defined, otherwise the universal file specification. More... | |
WStringCR | Moniker () const |
Gets the externalized DMS moniker string. More... | |
void | SetMoniker (WCharCP value) |
Sets the externalized DMS moniker string. More... | |
void | SetMoniker (WStringCR value) |
Sets the externalized DMS moniker string. More... | |
void | ClearMoniker () |
Clears the externalized DMS moniker string. More... | |
WStringCR | EmbeddedSuffix () const |
Gets the embedded suffix string. More... | |
void | SetEmbeddedSuffix (WCharCP value) |
Sets the embedded suffix string. More... | |
void | SetEmbeddedSuffix (WStringCR value) |
Sets the embedded suffix string. More... | |
void | ClearEmbeddedSuffix () |
Clears the embedded suffix string. More... | |
bool | IsFolder () const |
Gets flag indicating if this specification is for a folder. More... | |
void | SetIsFolder (bool value) |
Sets flag indicating if this specification is for a folder. More... | |
bool | IsReadOnly () const |
Gets flag indicating if this specification represents a read-only file or folder. More... | |
void | SetIsReadOnly (bool value) |
Sets flag indicating if this specification represents a read-only file or folder. More... | |
bool | IsNew () const |
Gets flag indicating if this specification represents a file or folder being created. More... | |
void | SetIsNew (bool value) |
Sets flag indicating if this specification represents a file or folder being created. More... | |
DgnDocumentP | Document () const |
DgnDocument pointer. May be undefined. More... | |
void | SetDocument (DgnDocumentCP value) |
Set the DgnDocument for this file specification. Adds reference to document. More... | |
DgnFolderP | Folder () const |
DgnFolder pointer. May be undefined. More... | |
void | SetFolder (DgnFolderCP value) |
Set the DgnFolder for this folder specification. Adds reference to folder. More... | |
bool | IsValid () const |
True if the universal file specification is defined. More... | |
bool | IsEmpty () const |
True if the universal file specification is not defined. More... | |
bool | IsHfsDefined () const |
True if the host file specification is defined. More... | |
bool | IsMonikerDefined () const |
True if the externalized moniker string is defined. More... | |
bool | IsEmbeddedSuffixDefined () const |
True if the embedded suffix is defined. More... | |
bool | IsHandleDefined () const |
True if DgnDocument or DgnFolder is defined. More... | |
bool | IsDms () const |
True if this file is DMS managed. More... | |
BeFileNameCR | DisplayFullName () const |
Gets the Ufs if DMS managed, otherwise HfsOrUfs(). More... | |
BeFileName | GetDisplayFullName (bool includeEmbeddedSuffix=false) const |
Gets the Ufs if DMS managed, otherwise GetHfsOrUfs (includeEmbeddedSuffix). More... | |
WString | GetFileName (bool includeEmbeddedSuffix=false) const |
Gets the file name and extension of the Hfs if defined, otherwise that of the Ufs. More... | |
WString | ToString () const |
Gets the display full name, including embedded suffix. More... | |
void | SetFromDgnDocument (DgnDocumentCP document) |
Populates FileSpec from a DgnDocument. More... | |
void | SetFromDgnFolder (DgnFolderCP folder) |
Populates FileSpec from a DgnFolder. More... | |
void | UpdateFromHandle () |
Updates the FolderSpec from its contained handle, if defined. More... | |
void | ClearHandle () |
Clears the document or folder handle, if defined. More... | |
void | Clear () |
Clears Ufs, Hfs, moniker, and handle. More... | |
static bool | ContainsEmbeddedSuffix (WStringCR path) |
True if the given path contains an embedded file specification. More... | |
static WString | GetEmbeddedSuffix (WStringCR path) |
Returns any embedded suffix from the given path. More... | |
static WString | RemoveEmbeddedSuffix (WStringCR path) |
Removes any embedded suffix from the given path. More... | |
static bool | Equals (PlotFileSpecCR comparand1, PlotFileSpecCR comparand2) |
Tests two PlotFileSpec instances for equality. More... | |
PlotPropValue () | |
~PlotPropValue () | |
PlotPropValue (int value) | |
Constructs from an integer value. More... | |
PlotPropValue (double value) | |
Constructs from a floating-point value. More... | |
PlotPropValue (WCharCP value) | |
Constructs from a string value. More... | |
PlotPropValue (PlotPropValueCR source) | |
Copy constructor. More... | |
PlotPropValueType | GetType () const |
Gets the property value type. More... | |
void | Assign (int value) |
Assigns an integer value. More... | |
void | Assign (double value) |
Assigns a floating-point value. More... | |
void | Assign (WCharCP value) |
Assigns a string value. More... | |
void | Clear () |
Clears the property value. More... | |
int | GetInt () const |
Gets the property value as an integer. More... | |
bool | GetBool () const |
Gets the property value as an boolean. More... | |
double | GetDouble () const |
Gets the property value as a floating-point number. More... | |
WCharCP | GetString () const |
Gets the property value as a string. More... | |
bool | IsValid () const |
True if the property value is defined. More... | |
void | ToString (WStringR str) const |
Converts the property value to a string. More... | |
bool | mdlPlot_getDefaultPltcfg (PlotFileSpecR pltcfgFspec) |
Returns the name of the default printer driver configuration file. More... | |
bool | mdlPlot_getDefaultSysPltcfg (PlotFileSpecR pltcfgFspec) |
Returns the name of the default system printer driver configuration file. More... | |
bool | mdlPlot_getDefaultPdfPltcfg (PlotFileSpecR pltcfgFspec) |
Returns the name of the default PDF printer driver configuration file. More... | |
StatusInt | mdlPlot_getPaperSizeListFromPrinter (PlotPaperSizeListR paperSizeList, WCharCP printerName, PlotOrientation orientation, PlotUnits units) |
Returns a list of paper sizes defined for the specified printer. More... | |
void | mdlPlot_getPrintStyleNames (PrintStyleNameListR printStyleNames, bool fromActiveDgnFile, bool fromDgnLibraries) |
Returns a list of print style names available in the current session. More... | |
IPrintDescriptionCP | mdlPlot_getPrintDialogDescHandle () |
Gets the IPrintDescription handle used by the plotdlg application (if it is loaded). More... | |
PlotError | mdlPlot_getErrno () |
Gets the current global plot error number. More... | |
void | mdlPlot_setErrno (PlotError value) |
Sets the current global plot error number. More... | |
Variables | |
WString | name |
Name. More... | |
BeFileName | sourceFileName |
File location in which the print style is defined. More... | |
WString | name |
Paper size name. More... | |
PlotUnits | units |
Paper size units. More... | |
DPoint2d | totalSize |
Physical paper size. More... | |
DPoint2d | printableSize |
Printable size. More... | |
DPoint2d | printableOffset |
Offset from physical origin to printable area. More... | |
int ival | |
double dval | |
WStringP sval | |
Friends | |
void | swap (PlotFileSpecR a, PlotFileSpecR b) |
Swaps two PlotFileSpec instances. More... | |
void | swap (PlotPropValueR a, PlotPropValueR b) |
Swaps two PlotPropValue instances. More... | |
General printing system classes, functions, and data types.
typedef bvector<PlotPaperSizeInfo> PlotPaperSizeList |
typedef bvector<PlotPaperSizeInfo>& PlotPaperSizeListR |
typedef bmap<WString,PlotPropValue> PlotPropertyMap |
typedef bmap<WString,PlotPropValue> const* PlotPropertyMapCP |
typedef bmap<WString,PlotPropValue> const& PlotPropertyMapCR |
typedef bmap<WString,PlotPropValue>* PlotPropertyMapP |
typedef bmap<WString,PlotPropValue>& PlotPropertyMapR |
typedef bvector<PrintStyleName>& PrintStyleNameListR |
|
strong |
|
strong |
Printing system error code.
Enumerator | |
---|---|
NoError |
No error. |
Internal |
Internal error. |
DiskFull |
Disk full error. |
UserAbort |
User abort. |
Malloc |
Memory allocation error. |
OpenFile |
Open file error. |
WriteFile |
Write file error. |
CreateFile |
Create file error. |
PermissionDenied |
Permission denied error. |
InvalidScale |
Invalid print scale error. |
IllegalWrite |
Illegal write error. |
Timeout |
Timeout. |
|
strong |
|
strong |
|
strong |
void Assign | ( | int | value | ) |
Assigns an integer value.
References Bentley::DgnPlatform::Clear.
void Assign | ( | double | value | ) |
Assigns a floating-point value.
References Bentley::DgnPlatform::Clear.
void Assign | ( | WCharCP | value | ) |
Assigns a string value.
References Bentley::DgnPlatform::Clear.
void Clear | ( | ) |
Clears Ufs, Hfs, moniker, and handle.
void Clear | ( | ) |
Clears the property value.
void ClearEmbeddedSuffix | ( | ) |
Clears the embedded suffix string.
void ClearHandle | ( | ) |
Clears the document or folder handle, if defined.
References NULL.
void ClearHfs | ( | ) |
Clears the host file specification.
void ClearMoniker | ( | ) |
Clears the externalized DMS moniker string.
|
static |
True if the given path contains an embedded file specification.
BeFileNameCR DisplayFullName | ( | ) | const |
Gets the Ufs if DMS managed, otherwise HfsOrUfs().
Does not include embedded suffix in HFS, if defined.
DgnDocumentP Document | ( | ) | const |
DgnDocument pointer. May be undefined.
WStringCR EmbeddedSuffix | ( | ) | const |
Gets the embedded suffix string.
|
static |
Tests two PlotFileSpec instances for equality.
DgnFolderP Folder | ( | ) | const |
DgnFolder pointer. May be undefined.
bool GetBool | ( | ) | const |
Gets the property value as an boolean.
BeFileName GetDisplayFullName | ( | bool | includeEmbeddedSuffix = false | ) | const |
Gets the Ufs if DMS managed, otherwise GetHfsOrUfs (includeEmbeddedSuffix).
Optionally appends the embedded suffix if defined.
double GetDouble | ( | ) | const |
Gets the property value as a floating-point number.
Returns any embedded suffix from the given path.
WString GetFileName | ( | bool | includeEmbeddedSuffix = false | ) | const |
Gets the file name and extension of the Hfs if defined, otherwise that of the Ufs.
Optionally appends the embedded suffix if defined.
BeFileName GetHfs | ( | bool | includeEmbeddedSuffix = false | ) | const |
Gets the host file specification.
Optionally includes the embedded suffix, if defined.
BeFileName GetHfsOrUfs | ( | bool | includeEmbeddedSuffix = false | ) | const |
Gets the host file specification if defined, otherwise the universal file specification.
Optionally includes the embedded suffix in the HFS, if defined.
int GetInt | ( | ) | const |
Gets the property value as an integer.
WCharCP GetString | ( | ) | const |
Gets the property value as a string.
References NULL.
PlotPropValueType GetType | ( | ) | const |
Gets the property value type.
BeFileName GetUfs | ( | bool | includeEmbeddedSuffix = false | ) | const |
Gets the universal file specification.
Optionally includes the embedded suffix, if defined.
BeFileNameCR Hfs | ( | ) | const |
Gets the host file specification, without any embedded suffix.
BeFileNameCR HfsOrUfs | ( | ) | const |
Gets the host file specification if defined, otherwise the universal file specification.
Does not include the embedded suffix in the HFS.
bool IsDms | ( | ) | const |
True if this file is DMS managed.
bool IsEmbeddedSuffixDefined | ( | ) | const |
True if the embedded suffix is defined.
bool IsEmpty | ( | ) | const |
True if the universal file specification is not defined.
bool IsFolder | ( | ) | const |
Gets flag indicating if this specification is for a folder.
bool IsHandleDefined | ( | ) | const |
True if DgnDocument or DgnFolder is defined.
References NULL.
bool IsHfsDefined | ( | ) | const |
True if the host file specification is defined.
bool IsMonikerDefined | ( | ) | const |
True if the externalized moniker string is defined.
bool IsNew | ( | ) | const |
Gets flag indicating if this specification represents a file or folder being created.
DgnDocument.OnNewFileCreated must be called to finish creation of files marked as new.
bool IsReadOnly | ( | ) | const |
Gets flag indicating if this specification represents a read-only file or folder.
bool IsValid | ( | ) | const |
True if the universal file specification is defined.
bool IsValid | ( | ) | const |
True if the property value is defined.
bool Bentley::MstnPlatform::mdlPlot_getDefaultPdfPltcfg | ( | PlotFileSpecR | pltcfgFspec | ) |
Returns the name of the default PDF printer driver configuration file.
The print dialog user preferences are used in conjunction with configuration variables to determine the default file.
[out] | pltcfgFspec | Default PDF printer driver configuration file. |
bool Bentley::MstnPlatform::mdlPlot_getDefaultPltcfg | ( | PlotFileSpecR | pltcfgFspec | ) |
Returns the name of the default printer driver configuration file.
The print dialog user preferences are used in conjunction with configuration variables to determine the default file.
[out] | pltcfgFspec | Default printer driver configuration file. |
bool Bentley::MstnPlatform::mdlPlot_getDefaultSysPltcfg | ( | PlotFileSpecR | pltcfgFspec | ) |
Returns the name of the default system printer driver configuration file.
The print dialog user preferences are used in conjunction with configuration variables to determine the default file.
[out] | pltcfgFspec | Default system printer driver configuration file. |
PlotError Bentley::MstnPlatform::mdlPlot_getErrno | ( | ) |
Gets the current global plot error number.
StatusInt Bentley::MstnPlatform::mdlPlot_getPaperSizeListFromPrinter | ( | PlotPaperSizeListR | paperSizeList, |
WCharCP | printerName, | ||
PlotOrientation | orientation, | ||
PlotUnits | units | ||
) |
Returns a list of paper sizes defined for the specified printer.
[out] | paperSizeList | Paper size list. |
[in] | printerName | Either a .pltcfg file name or a Windows printer name. |
[in] | orientation | Desired orientation for paper sizes. |
[in] | units | Desired paper size units. |
IPrintDescriptionCP Bentley::MstnPlatform::mdlPlot_getPrintDialogDescHandle | ( | ) |
Gets the IPrintDescription handle used by the plotdlg application (if it is loaded).
If plotdlg is not loaded, the returned handle is NULL.
void Bentley::MstnPlatform::mdlPlot_getPrintStyleNames | ( | PrintStyleNameListR | printStyleNames, |
bool | fromActiveDgnFile, | ||
bool | fromDgnLibraries | ||
) |
Returns a list of print style names available in the current session.
[out] | printStyleNames | List of print style names. |
[in] | fromActiveDgnFile | True to include print styles from the active DGN. |
[in] | fromDgnLibraries | True to include print styles from dgnlibs. |
void Bentley::MstnPlatform::mdlPlot_setErrno | ( | PlotError | value | ) |
Sets the current global plot error number.
[in] | value | New error code. |
WStringCR Moniker | ( | ) | const |
Gets the externalized DMS moniker string.
PlotFileSpecR operator= | ( | PlotFileSpecCR | source | ) |
Assigns from another PlotFileSpec instance.
PlotFileSpec | ( | ) |
Default constructor.
PlotFileSpec | ( | WStringCR | ufs | ) |
Constructs a PlotFileSpec from a universal file specification.
PlotFileSpec | ( | WStringCR | ufs, |
bool | isHfs | ||
) |
Constructs a PlotFileSpec from a universal file specification, while also optionally setting the host file specification to the same value.
PlotFileSpec | ( | WCharCP | ufs | ) |
Constructs a PlotFileSpec from a universal file specification.
PlotFileSpec | ( | WCharCP | ufs, |
bool | isHfs | ||
) |
Constructs a PlotFileSpec from a universal file specification, while also optionally setting the host file specification to the same value.
PlotFileSpec | ( | DgnDocumentCP | document | ) |
Constructs a PlotFileSpec from a DgnDocument.
PlotFileSpec | ( | DgnFolderCP | folder | ) |
Constructs a PlotFileSpec from a DgnDocument.
PlotFileSpec | ( | PlotFileSpecCR | source | ) |
Copy constructor.
PlotPropValue | ( | ) |
PlotPropValue | ( | int | value | ) |
Constructs from an integer value.
PlotPropValue | ( | double | value | ) |
Constructs from a floating-point value.
PlotPropValue | ( | WCharCP | value | ) |
Constructs from a string value.
PlotPropValue | ( | PlotPropValueCR | source | ) |
Copy constructor.
Removes any embedded suffix from the given path.
References WString::substr().
void SetDocument | ( | DgnDocumentCP | value | ) |
Set the DgnDocument for this file specification. Adds reference to document.
void SetEmbeddedSuffix | ( | WCharCP | value | ) |
Sets the embedded suffix string.
void SetEmbeddedSuffix | ( | WStringCR | value | ) |
Sets the embedded suffix string.
References PlotFileSpec::SetEmbeddedSuffix().
Referenced by PlotFileSpec::SetEmbeddedSuffix().
void SetFolder | ( | DgnFolderCP | value | ) |
Set the DgnFolder for this folder specification. Adds reference to folder.
void SetFromDgnDocument | ( | DgnDocumentCP | document | ) |
Populates FileSpec from a DgnDocument.
void SetFromDgnFolder | ( | DgnFolderCP | folder | ) |
Populates FileSpec from a DgnFolder.
void SetHfs | ( | WCharCP | value | ) |
Sets the host file specification.
May also set the universal file specification and embedded suffix.
void SetIsFolder | ( | bool | value | ) |
Sets flag indicating if this specification is for a folder.
void SetIsNew | ( | bool | value | ) |
Sets flag indicating if this specification represents a file or folder being created.
DgnDocument.OnNewFileCreated must be called to finish creation of files marked as new.
void SetIsReadOnly | ( | bool | value | ) |
Sets flag indicating if this specification represents a read-only file or folder.
void SetMoniker | ( | WCharCP | value | ) |
Sets the externalized DMS moniker string.
void SetMoniker | ( | WStringCR | value | ) |
Sets the externalized DMS moniker string.
References PlotFileSpec::SetMoniker().
Referenced by PlotFileSpec::SetMoniker().
void SetUfs | ( | WCharCP | value | ) |
Sets the universal file specification.
Clears host file specification and moniker. May set or clear the embedded suffix.
References Bentley::DgnPlatform::Clear.
void SetUfsAndHfs | ( | WCharCP | value | ) |
Sets both the universal and host file specifications.
Clears the moniker. Sets of clears the embedded suffix.
void SetUfsOnly | ( | WStringCR | value | ) |
Sets the universal file specification without clearing anything.
Intended only for low-level code that manually populates all file specification fields.
WString ToString | ( | ) | const |
Gets the display full name, including embedded suffix.
void ToString | ( | WStringR | str | ) | const |
Converts the property value to a string.
References WString::Sprintf().
BeFileNameCR Ufs | ( | ) | const |
Gets the universal file specification, without any embedded suffix.
void UpdateFromHandle | ( | ) |
Updates the FolderSpec from its contained handle, if defined.
~PlotFileSpec | ( | ) |
Destructor.
~PlotPropValue | ( | ) |
References Bentley::DgnPlatform::Clear.
double dval |
double dval |
int ival |
int ival |
WString name |
Name.
WString name |
Paper size name.
DPoint2d printableOffset |
Offset from physical origin to printable area.
DPoint2d printableSize |
Printable size.
BeFileName sourceFileName |
File location in which the print style is defined.
WStringP sval |
WStringP sval |
DPoint2d totalSize |
Physical paper size.
PlotUnits units |
Paper size units.
|
friend |
Swaps two PlotFileSpec instances.
|
friend |
Swaps two PlotPropValue instances.