#include <PdfPublishSignatureField.h>

Inheritance diagram for OdPdfPublish::OdSignatureField:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdSignatureField)

	ODRX_HEAP_OPERATORS ()

	OdSignatureField ()

virtual	~OdSignatureField ()

void	setName (const OdString &name)

void	setFont (Text::StandardFontsType fontType)

void	setFont (const OdString &fontName, Text::FontStyle fontStyle=Text::kRegular)

void	setFontSize (OdUInt16 size)

void	setTextColor (ODCOLORREF color)

void	setTooltip (const OdString &tooltip)

void	setVisibility (bool state)

void	setPrintability (bool state)

void	setTextRotation (Text::Rotation rotation)

void	setLock (bool state)

void	setBorder (bool state)

void	setBorderColor (ODCOLORREF color)

void	setBorderThickness (Border::Thickness thickness)

void	setBorderStyle (Border::Style style)

void	setFillColor (ODCOLORREF color)

void	getName (OdString &name) const

void	getFont (Text::StorageType &storageType, Text::StandardFontsType &fontType, OdString &fontName, Text::FontStyle &fontStyle) const

void	getFontSize (OdUInt16 &size) const

void	getTextColor (ODCOLORREF &color) const

void	getTooltip (OdString &tooltip) const

void	getVisibility (bool &state) const

void	getPrintability (bool &state) const

void	getTextRotation (Text::Rotation &rotation) const

void	getLock (bool &state) const

void	getBorder (bool &state) const

void	getBorderColor (ODCOLORREF &color) const

void	getBorderThickness (Border::Thickness &thickness) const

void	getBorderStyle (Border::Style &style) const

void	getFillColor (ODCOLORREF &color) const

Public Member Functions inherited from OdPdfPublish::OdObject
	ODRX_DECLARE_MEMBERS (OdObject)

	ODRX_HEAP_OPERATORS ()

virtual	~OdObject ()

virtual bool	isEmpty () const

virtual bool	isValid () const

virtual void	clear ()

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

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

static OdRxClass *	desc ()

Protected Member Functions inherited from OdPdfPublish::OdObject
	OdObject (OdPublishObjectImpl *pImpl)

Detailed Description

This class implements a signature field contained in a .pdf document created with Teigha Publish.

Definition at line 44 of file PdfPublishSignatureField.h.

Constructor & Destructor Documentation

◆ OdSignatureField()

OdPdfPublish::OdSignatureField::OdSignatureField ( )

Creates an instance of signature field.

◆ ~OdSignatureField()

virtual OdPdfPublish::OdSignatureField::~OdSignatureField ( )

virtual

Destroys the signature field instance.

Member Function Documentation

◆ getBorder()

void OdPdfPublish::OdSignatureField::getBorder ( bool & state ) const

Returns current value of the flag that determines whether the signature field has a border. If the flag value is equal to true, the signature field has a border, otherwise it has not. The method fills a passed boolean value with the signature field border flag value and returns it to a calling subroutine.

Parameters

state [out] A placeholder for the flag value.

◆ getBorderColor()

void OdPdfPublish::OdSignatureField::getBorderColor ( ODCOLORREF & color ) const

Returns current signature field border color. The method fills a passed ODCOLORREF value with the signature field border color value and returns it to a calling subroutine.

Parameters

color [out] A placeholder for the color value.

◆ getBorderStyle()

void OdPdfPublish::OdSignatureField::getBorderStyle ( Border::Style & style ) const

Returns current signature field border style. The method fills a passed value with current signature field border style and returns it to a calling subroutine.

Parameters

style [out] A placeholder for the border style.

See also: <link OdPdfPublish::Border::Style, Border::Style enumeration>

◆ getBorderThickness()

void OdPdfPublish::OdSignatureField::getBorderThickness ( Border::Thickness & thickness ) const

Returns current signature field border thickness. The method fills a passed value with curretn signature field border thickness and returns it to a calling subroutine.

Parameters

thickness [out] A placeholder for the border thickness value.

See also: <link OdPdfPublish::Border::Thickness, Border::Thickness enumeration>

◆ getFillColor()

void OdPdfPublish::OdSignatureField::getFillColor ( ODCOLORREF & color ) const

Returns current signature field filling color. The method fills a passed ODCOLORREF value with the signature field filling color value and returns it to a calling subroutine.

Parameters

color [out] A placeholder for the color value.

◆ getFont()

void OdPdfPublish::OdSignatureField::getFont	(	Text::StorageType &	storageType,
		Text::StandardFontsType &	fontType,
		OdString &	fontName,
		Text::FontStyle &	fontStyle
	)		const

Returns current font name used for displaying signature field caption. The method fills a passed string object and Text::FontStyle value with current signature field font name and style, then returns them to a calling subroutine.

Parameters

font_name	[out] A placeholder for the font name that should be used for the signature field.
style	[out] A placeholder for the font style that should be used for the signature field.

See also: <link OdPdfPublish::Text::FontStyle, Text::FontStyle enumeration>

◆ getFontSize()

void OdPdfPublish::OdSignatureField::getFontSize ( OdUInt16 & size ) const

Returns current font size used for displaying signature field caption. The method fills a passed integer value with the signature field font size and returns it to a calling subroutine.

Parameters

size	[out] A placeholder for the font size that should be used for the signature field.

◆ getLock()

void OdPdfPublish::OdSignatureField::getLock ( bool & state ) const

Returns current value of the flag that determines whether the signature field is locked. If the flag value is equal to true, the signature field is locked and becomes disabled otherwise it enabled and unlocked. The method fills a passed boolean value with the signature field lock flag value and returns it to a calling subroutine.

Parameters

state [out] A placeholder for the flag value.

◆ getName()

void OdPdfPublish::OdSignatureField::getName ( OdString & name ) const

Returns current name of the signature field. The method fills a passed string object with signature field name and returns it to a calling subroutine.

Parameters

name	[out] A placeholder for the the signature field name.

◆ getPrintability()

void OdPdfPublish::OdSignatureField::getPrintability ( bool & state ) const

Returns current value of the flag that determines whether the signature field should be printed. If the signature field should be printed, the flag value is equal to true, otherwise it is equal to false. The method fills a passed boolean value with the signature field printability flag value and returns it to a calling subroutine.

Parameters

state [out] A placeholder for the flag value.

◆ getTextColor()

void OdPdfPublish::OdSignatureField::getTextColor ( ODCOLORREF & color ) const

Returns current text color used for displaying signature field caption. The method fills a passed ODCOLORREF value with the signature field caption color and returns it to a calling subroutine.

Parameters

color [out] A placeholder for the text color that should be used for the signature field caption.

◆ getTextRotation()

void OdPdfPublish::OdSignatureField::getTextRotation ( Text::Rotation & rotation ) const

Returns current text rotation of the signature field. The method fills a passed value with current signature field text rotation and returns it to a calling subroutine.

Parameters

rotation [out] A placeholder for the text rotation value.

See also: <link OdPdfPublish::Text::Rotation, Text::Rotation enumeration>

◆ getTooltip()

void OdPdfPublish::OdSignatureField::getTooltip ( OdString & tooltip ) const

Returns current tooltip text for the signature field. Tooltip text is a text that appears when a user hovers the mouse pointer over the signature field.

The method fills a passed string object with the signature field tooltip text and returns it to a calling subroutine.

Parameters

tooptip [out] A placeholder for the tooltip text.

◆ getVisibility()

void OdPdfPublish::OdSignatureField::getVisibility ( bool & state ) const

Returns current value of the visibility flag for the signature field. Visibility flag determines whether the signature field is visible in document (if true) or is hidden (if false). The method fills a passed boolean value with the signature field visibility flag value and returns it to a calling subroutine.

Parameters

state [out] A placeholder for the flag value.

◆ ODRX_DECLARE_MEMBERS()

OdPdfPublish::OdSignatureField::ODRX_DECLARE_MEMBERS ( OdSignatureField )

◆ ODRX_HEAP_OPERATORS()

OdPdfPublish::OdSignatureField::ODRX_HEAP_OPERATORS ( )

◆ setBorder()

void OdPdfPublish::OdSignatureField::setBorder ( bool state )

Sets a new value of the flag that determines whether the signature field has a border. If the flag value is equal to true, the signature field has a border, otherwise it has not.

Parameters

state [in] A new flag value.

◆ setBorderColor()

void OdPdfPublish::OdSignatureField::setBorderColor ( ODCOLORREF color )

Sets the signature field border color.

Parameters

color [in] A new color value.

◆ setBorderStyle()

void OdPdfPublish::OdSignatureField::setBorderStyle ( Border::Style style )

Sets the signature field border style.

Parameters

style [in] A new border style.

See also: <link OdPdfPublish::Border::Style, Border::Style enumeration>

◆ setBorderThickness()

void OdPdfPublish::OdSignatureField::setBorderThickness ( Border::Thickness thickness )

Sets the signature field border thickness.

Parameters

thickness [in] A new border thickness value.

See also: <link OdPdfPublish::Border::Thickness, Border::Thickness enumeration>

◆ setFillColor()

void OdPdfPublish::OdSignatureField::setFillColor ( ODCOLORREF color )

Sets the signature field button filling color.

Parameters

color [in] A new color value.

◆ setFont() [1/2]

void OdPdfPublish::OdSignatureField::setFont	(	const OdString &	fontName,
		Text::FontStyle	fontStyle = `Text::kRegular`
	)

Sets a font name and style of the signature field.

Parameters

name	[in] A new font name of the signature field.
style	[in] A new font style of the signature field.

See also: <link OdPdfPublish::Text::FontStyle, Text::FontStyle enumeration>

◆ setFont() [2/2]

void OdPdfPublish::OdSignatureField::setFont ( Text::StandardFontsType fontType )

◆ setFontSize()

void OdPdfPublish::OdSignatureField::setFontSize ( OdUInt16 size )

Sets a font size of the signature field.

Parameters

size	[in] A new font size value of the signature field.

◆ setLock()

void OdPdfPublish::OdSignatureField::setLock ( bool state )

Sets a new value of the flag that determines whether the signature field is locked. If the flag value is equal to true, the signature field is locked and becomes disabled otherwise it enabled and unlocked.

Parameters

state [in] A new flag value.

◆ setName()

void OdPdfPublish::OdSignatureField::setName ( const OdString & name )

Sets the signature field name.

Parameters

name	[in] A new signature field name.

Remarks: The name is mandatory and must be unique among the document object names.

◆ setPrintability()

void OdPdfPublish::OdSignatureField::setPrintability ( bool state )

Sets a new value of the flag that determines whether the signature field should be printed. If the signature field should be printed, the flag value is equal to true, otherwise it is equal to false.

Parameters

state [in] A new flag value.

◆ setTextColor()

void OdPdfPublish::OdSignatureField::setTextColor ( ODCOLORREF color )

Sets a text color of the signature field.

Parameters

color [in] A new color value.

◆ setTextRotation()

void OdPdfPublish::OdSignatureField::setTextRotation ( Text::Rotation rotation )

Sets a new value of the signature field text rotation.

Parameters

rotation [in] A new text rotation value.

See also: <link OdPdfPublish::Text::Rotation, Text::Rotation enumeration>

◆ setTooltip()

void OdPdfPublish::OdSignatureField::setTooltip ( const OdString & tooltip )

Sets a tooltip text for the signature field. Tooltip text is a text that appears when a user hovers the mouse pointer over the signature field.

Parameters

tooptip [in] A new value of the tooltip text.

◆ setVisibility()

void OdPdfPublish::OdSignatureField::setVisibility ( bool state )

Sets a new value of the visibility flag for the signature field. Visibility flag determines whether the signature field is visible in document (if true) or is hidden (if false).

Parameters

state [in] A new flag value.

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

PdfPublishSignatureField.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdSignatureField()

◆ ~OdSignatureField()

Member Function Documentation

◆ getBorder()

◆ getBorderColor()

◆ getBorderStyle()

◆ getBorderThickness()

◆ getFillColor()

◆ getFont()

◆ getFontSize()

◆ getLock()

◆ getName()

◆ getPrintability()

◆ getTextColor()

◆ getTextRotation()

◆ getTooltip()

◆ getVisibility()

◆ ODRX_DECLARE_MEMBERS()

◆ ODRX_HEAP_OPERATORS()

◆ setBorder()

◆ setBorderColor()

◆ setBorderStyle()

◆ setBorderThickness()

◆ setFillColor()

◆ setFont() [1/2]

◆ setFont() [2/2]

◆ setFontSize()

◆ setLock()

◆ setName()

◆ setPrintability()

◆ setTextColor()

◆ setTextRotation()

◆ setTooltip()

◆ setVisibility()