#include <PdfPublishCheckBox.h>

Inheritance diagram for OdPdfPublish::OdCheckBox:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdCheckBox)

	ODRX_HEAP_OPERATORS ()

virtual	~OdCheckBox ()

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	setExportValue (const OdString &export_value)

void	setDefaultState (bool state)

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

void	getExportValue (OdString &export_value) const

void	getDefaultState (bool &default_state) 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

Protected Member Functions
	OdCheckBox ()

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

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

static OdRxClass *	desc ()

Detailed Description

This class implements a checkbox control encapsulated in a .pdf document created with Publish SDK. A checkbox control is used in a .pdf document to set any boolean parameters and can accept two values: true (the checkbox is switched on) and false (the checkbox is switched off).

Definition at line 47 of file PdfPublishCheckBox.h.

Constructor & Destructor Documentation

◆ OdCheckBox()

OdPdfPublish::OdCheckBox::OdCheckBox ( )

protected

◆ ~OdCheckBox()

virtual OdPdfPublish::OdCheckBox::~OdCheckBox ( )

virtual

Destroys a checkbox control.

Member Function Documentation

◆ getBorder()

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

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

Parameters

state [out] A placeholder for the flag value.

◆ getBorderColor()

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

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

Parameters

color [out] A placeholder for the color value.

◆ getBorderStyle()

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

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

Parameters

style [out] A placeholder for the style value.

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

◆ getBorderThickness()

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

Returns the current checkbox border thickness. The method fills a passed value with the current border thickness and returns it to a calling subroutine.

Parameters

thickness [out] A placeholder for the thickness value.

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

◆ getDefaultState()

void OdPdfPublish::OdCheckBox::getDefaultState ( bool & default_state ) const

Returns the current checkbox default state. If the default state is equal to true, the checkbox is switched on when it displays in a document, otherwise the checbox is switched off. The method fills a boolean object with the checkbox default state value and returns it to a calling subroutine.

Parameters

default_state [out] A placeholder for the default state value.

◆ getExportValue()

void OdPdfPublish::OdCheckBox::getExportValue ( OdString & export_value ) const

Returns the current export value for the checkbox. The method fills a passed string object with the checkbox export value and returns it to a calling subroutine.

Parameters

export_value [out] A placeholder for the export value.

◆ getFillColor()

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

Returns the current checkbox fill color. The method fills a passed ODCOLORREF value with the checkbox fill color value and returns it to a calling subroutine.

Parameters

color [out] A placeholder for the color value.

◆ getFont()

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

Returns the current font parameters used for displaying the checkbox caption. The method fills passed values and returns them to a calling subroutine.

Parameters

storageType	[out] A placeholder for the storage type.
fontType	[out] A placeholder for the font type that should be used for the checkbox.
fontName	[out] A placeholder for the font name that should be used for the checkbox.
fontStyle	[out] A placeholder for the font style that should be used for the checkbox.

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

◆ getFontSize()

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

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

Parameters

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

◆ getLock()

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

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

Parameters

state [out] A placeholder for the flag value.

◆ getName()

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

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

Parameters

name	[out] A placeholder for the checkbox name.

◆ getPrintability()

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

Returns the current value of the flag that determines whether the checkbox should be printed. If the checkbox 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 checkbox printability flag value and returns it to a calling subroutine.

Parameters

state [out] A placeholder for the flag value.

◆ getTextColor()

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

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

Parameters

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

◆ getTextRotation()

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

Returns the current rotation for the checkbox text. The method fills a passed value with current rotation value and returns it to a calling subroutine.

Parameters

rotation [out] A placeholder for the rotation value.

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

◆ getTooltip()

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

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

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

Parameters

tooltip [out] A placeholder for the tooltip text.

◆ getVisibility()

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

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

Parameters

state [out] A placeholder for the flag value.

◆ ODRX_DECLARE_MEMBERS()

OdPdfPublish::OdCheckBox::ODRX_DECLARE_MEMBERS ( OdCheckBox )

◆ ODRX_HEAP_OPERATORS()

OdPdfPublish::OdCheckBox::ODRX_HEAP_OPERATORS ( )

◆ setBorder()

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

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

Parameters

state [in] A new flag value.

◆ setBorderColor()

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

Sets a checkbox border color.

Parameters

color [in] A new color value.

◆ setBorderStyle()

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

Sets a checkbox border style.

Parameters

style [in] A new border style value.

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

◆ setBorderThickness()

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

Sets a checkbox border thickness.

Parameters

thickness [in] A new thickness value.

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

◆ setDefaultState()

void OdPdfPublish::OdCheckBox::setDefaultState ( bool state )

Sets a checkbox default state. If the default state is equal to true, the checkbox is switched on when it is displayed in a document, otherwise the checbox is switched off.

Parameters

state [in] A new default state.

◆ setExportValue()

void OdPdfPublish::OdCheckBox::setExportValue ( const OdString & export_value )

Sets an export value for the checkbox.

Parameters

export_value [in] A new export value.

◆ setFillColor()

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

Sets a checkbox fill color.

Parameters

color [in] A new color value.

◆ setFont() [1/2]

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

Sets the checkbox font name and style.

Parameters

fontName	[in] A new font name.
fontStyle	[in] A new font style.

Remarks: This method can set a font that is not in the list of <link OdPdfPublish::Text::StandardFontsType, standard fonts>. By default the <link OdPdfPublish::Text::StandardFontsType::kTimesRoman, normal Times New Roman font> is used.

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

◆ setFont() [2/2]

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

Sets the checkbox font type from the list of <link OdPdfPublish::Text::StandardFontsType, predefined fonts>.

Parameters

fontType [in] A new font type value.

See also: <link OdPdfPublish::Text::StandardFontsType, Text::StandardFontsType enumeration>.

◆ setFontSize()

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

Sets a font size used for displaying the checkbox caption.

Parameters

size	[in] A new value of the font size that should be used for the checkbox caption.

◆ setLock()

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

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

Parameters

state [in] A new flag value.

◆ setName()

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

Sets a name for the checkbox.

Parameters

name	[in] A new value of the checkbox name.

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

◆ setPrintability()

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

Sets a new value of the flag that determines whether the checkbox should be printed. If the checkbox 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::OdCheckBox::setTextColor ( ODCOLORREF color )

Sets a text color used for displaying the checkbox caption.

Parameters

color [in] A new value of the text color that should be used for the checkbox caption.

◆ setTextRotation()

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

Sets a new rotation value for the checkbox text.

Parameters

rotation [in] A new rotation value.

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

◆ setTooltip()

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

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

Parameters

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

◆ setVisibility()

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

Sets a new value of the visibility flag for the checkbox. The visibility flag determines whether the checkbox is visible in a 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:

PdfPublishCheckBox.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdCheckBox()

◆ ~OdCheckBox()

Member Function Documentation

◆ getBorder()

◆ getBorderColor()

◆ getBorderStyle()

◆ getBorderThickness()

◆ getDefaultState()

◆ getExportValue()

◆ getFillColor()

◆ getFont()

◆ getFontSize()

◆ getLock()

◆ getName()

◆ getPrintability()

◆ getTextColor()

◆ getTextRotation()

◆ getTooltip()

◆ getVisibility()

◆ ODRX_DECLARE_MEMBERS()

◆ ODRX_HEAP_OPERATORS()

◆ setBorder()

◆ setBorderColor()

◆ setBorderStyle()

◆ setBorderThickness()

◆ setDefaultState()

◆ setExportValue()

◆ setFillColor()

◆ setFont() [1/2]

◆ setFont() [2/2]

◆ setFontSize()

◆ setLock()

◆ setName()

◆ setPrintability()

◆ setTextColor()

◆ setTextRotation()

◆ setTooltip()

◆ setVisibility()