Appearance information for a widget annotation. More...

#include <jawsmako/interactive.h>

Inheritance diagram for JawsMako::IWidgetAppearanceCharacteristics:

Public Member Functions
virtual int32	getRotation () const =0
	Get the rotation of the widget appearance.
virtual void	setRotation (int32 rotation)=0
	Set the rotation of the widget appearance.
virtual IDOMColorPtr	getBorderColor () const =0
	Get the border color of the widget.
virtual void	setBorderColor (const IDOMColorPtr &color)=0
	Set the border color of the widget.
virtual IDOMColorPtr	getBackgroundColor () const =0
	Get the background color of the widget.
virtual void	setBackgroundColor (const IDOMColorPtr &color)=0
	Set the background color of the widget.
virtual U8String	getCaption () const =0
	Get the caption for the widget.
virtual void	setCaption (const U8String &caption)=0
	Set the caption for the widget.
virtual U8String	getRolloverCaption () const =0
	Get the rollover caption for the widget.
virtual void	setRolloverCaption (const U8String &caption)=0
	Set the rollover caption for the widget.
virtual U8String	getAlternateCaption () const =0
	Get the alternate caption for the widget.
virtual void	setAlternateCaption (const U8String &caption)=0
	Set the alternate caption for the widget.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static JAWSMAKO_API IWidgetAppearanceCharacteristicsPtr	create (const IJawsMakoPtr &jawsMako, int32 rotation=0, const IDOMColorPtr &borderColor=IDOMColorPtr(), const IDOMColorPtr &backgroundColor=IDOMColorPtr(), const U8String &caption=U8String(), const U8String &rolloverCaption=U8String(), const U8String &alternateCaption=U8String())
	Create a new widget appearance characteristics.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

Appearance information for a widget annotation.

Member Function Documentation

◆ create()

JAWSMAKO_API IWidgetAppearanceCharacteristicsPtr JawsMako::IWidgetAppearanceCharacteristics::create	(	const IJawsMakoPtr &	jawsMako,
		int32	rotation = 0,
		const IDOMColorPtr &	borderColor = IDOMColorPtr(),
		const IDOMColorPtr &	backgroundColor = IDOMColorPtr(),
		const U8String &	caption = U8String(),
		const U8String &	rolloverCaption = U8String(),
		const U8String &	alternateCaption = U8String() )

static

Create a new widget appearance characteristics.

Parameters

jawsMako	The Mako instance.
rotation	The rotation of the widget in degrees. Must be a multiple of 90.
borderColor	The color to use for the border. Must use a DeviceGray, DeviceRGB or DeviceCMYK color space.
backgroundColor	The color to use for the background. Must use a DeviceGray, DeviceRGB or DeviceCMYK color space.
caption	The widget's normal caption.
rolloverCaption	The widget's rollover caption. Used only for push button widgets.
alternateCaption	The widgets's alternate caption. Used only for push button widgets.

Returns: IWidgetAppearanceCharacteristicsPtr The new instance.

◆ getAlternateCaption()

virtual U8String JawsMako::IWidgetAppearanceCharacteristics::getAlternateCaption ( ) const

pure virtual

Get the alternate caption for the widget.

Returns: U8String The caption, or an empty string if not present.

◆ getBackgroundColor()

virtual IDOMColorPtr JawsMako::IWidgetAppearanceCharacteristics::getBackgroundColor ( ) const

pure virtual

Get the background color of the widget.

Returns: IDOMColorPtr The color, or NULL if not present.

◆ getBorderColor()

virtual IDOMColorPtr JawsMako::IWidgetAppearanceCharacteristics::getBorderColor ( ) const

pure virtual

Get the border color of the widget.

Returns: IDOMColorPtr The color, or NULL if not present.

◆ getCaption()

virtual U8String JawsMako::IWidgetAppearanceCharacteristics::getCaption ( ) const

pure virtual

Get the caption for the widget.

Returns: U8String The caption, or an empty string if not present.

◆ getRolloverCaption()

virtual U8String JawsMako::IWidgetAppearanceCharacteristics::getRolloverCaption ( ) const

pure virtual

Get the rollover caption for the widget.

Returns: U8String The caption, or an empty string if not present.

◆ getRotation()

virtual int32 JawsMako::IWidgetAppearanceCharacteristics::getRotation ( ) const

pure virtual

Get the rotation of the widget appearance.

Returns: int32 The rotation, in degrees

◆ setAlternateCaption()

virtual void JawsMako::IWidgetAppearanceCharacteristics::setAlternateCaption ( const U8String & caption )

pure virtual

Set the alternate caption for the widget.

Parameters

caption The caption, or an empty string to clear.

◆ setBackgroundColor()

virtual void JawsMako::IWidgetAppearanceCharacteristics::setBackgroundColor ( const IDOMColorPtr & color )

pure virtual

Set the background color of the widget.

Parameters

color The color, or NULL to clear. Must use either DeviceGray, DeviceRGB, or DeviceCMYK.

◆ setBorderColor()

virtual void JawsMako::IWidgetAppearanceCharacteristics::setBorderColor ( const IDOMColorPtr & color )

pure virtual

Set the border color of the widget.

Parameters

color The color, or NULL to clear. Must use either DeviceGray, DeviceRGB, or DeviceCMYK.

◆ setCaption()

virtual void JawsMako::IWidgetAppearanceCharacteristics::setCaption ( const U8String & caption )

pure virtual

Set the caption for the widget.

Parameters

caption The caption, or an empty string to clear.

◆ setRolloverCaption()

virtual void JawsMako::IWidgetAppearanceCharacteristics::setRolloverCaption ( const U8String & caption )

pure virtual

Set the rollover caption for the widget.

Parameters

caption The caption, or an empty string to clear.

◆ setRotation()

virtual void JawsMako::IWidgetAppearanceCharacteristics::setRotation ( int32 rotation )

pure virtual

Set the rotation of the widget appearance.

Parameters

rotation The rotation in degrees. Must be a multiple of 90 degrees.

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

jawsmako/interactive.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ create()

◆ getAlternateCaption()

◆ getBackgroundColor()

◆ getBorderColor()

◆ getCaption()

◆ getRolloverCaption()

◆ getRotation()

◆ setAlternateCaption()

◆ setBackgroundColor()

◆ setBorderColor()

◆ setCaption()

◆ setRolloverCaption()

◆ setRotation()