Class: TDisplayDeviceConfiguration

Declaration: DisplayConfiguration.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TBaseDisplayDeviceConfiguration

Inherited By:

TFrameBufferConfiguration

Purpose:

This class is used to make configuration changes for display devices. It is a concrete derivative class of TBaseDisplayDeviceConfiguration.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

TFrameBufferConfiguration is an example of a derived class. Derived classes do not need to override any functions, but usually add setters for new and specific configuration commands.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TDisplayDeviceConfiguration::TDisplayDeviceConfiguration

TDisplayDeviceConfiguration (TDisplayDeviceHandle & aDevice)
TDisplayDeviceConfiguration (TDequeOf < TDisplayDeviceHandle > &)

Interface Category:

API.

Purpose:

Creates a configuration change object for a single display.
Creates a configuration change object for a deque of displays.

Calling Context:

Called to change a single display.
Called to change many displays.

Parameters:

TDisplayDeviceHandle & displayToChange -The display to change.
TDequeOf < TDisplayDeviceHandle > & -The deque of Displays to change.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDisplayDeviceConfiguration::~TDisplayDeviceConfiguration

virtual ~ TDisplayDeviceConfiguration ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDisplayDeviceConfiguration::SetWorldBoundsOffset

virtual void SetWorldBoundsOffset (const TGPoint theOffset, const DeviceNumberType DeviceNum =0)

Interface Category:

API.

Purpose:

Sets the bounds offset of the display.

Calling Context:

Called to move the device's position.

Parameters:

const TGPoint theOffset -New offset.
const DeviceNumberType DeviceNum =0 -Device to move.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDisplayDeviceConfiguration::SetDisplayWidth

virtual void SetDisplayWidth (const GCoordinate theWidth, const DeviceNumberType DeviceNum =0)

Interface Category:

API.

Purpose:

Sets the width of the display.

Calling Context:

Called to change the display's width.

Parameters:

const GCoordinate theWidth -The new width.
const DeviceNumberType DeviceNum =0 -The display to change.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDisplayDeviceConfiguration::SetDisplayHeight

virtual void SetDisplayHeight (const GCoordinate theHeight, const DeviceNumberType DeviceNum =0)

Interface Category:

API.

Purpose:

Sets the height of the display.

Calling Context:

Called to set the height of the display.

Parameters:

const GCoordinate theHeight -The new height.
const DeviceNumberType DeviceNum =0 -The display to change.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDisplayDeviceConfiguration::OrderRightToLeft

virtual void OrderRightToLeft ()

Interface Category:

API.

Purpose:

Sets the position of all the displays so they form a row ordered from right to left.

Calling Context:

Called to automatically position all displays to form a row.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDisplayDeviceConfiguration::OrderLeftToRight

virtual void OrderLeftToRight ()

Interface Category:

API.

Purpose:

Sets the position of all the displays so they form a row ordered from left to right.

Calling Context:

Called to automatically position all displays to form a row.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDisplayDeviceConfiguration::OrderTopToBottom

virtual void OrderTopToBottom ()

Interface Category:

API.

Purpose:

Sets the position of all the displays so they form a column ordered from top to bottom.

Calling Context:

Called to automatically position all displays to form a column.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDisplayDeviceConfiguration::OrderBottomToTop

virtual void OrderBottomToTop ()

Interface Category:

API.

Purpose:

Sets the position of all the displays so they form a column ordered from bottom to top.

Calling Context:

Called to automatically position all displays to form a column.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDisplayDeviceConfiguration::OrderAsMatrix

virtual void OrderAsMatrix (DeviceNumberType Width)

Interface Category:

API.

Purpose:

Sets the offset of all displays to form a rectangular matrix.

Calling Context:

Called to order all the displays.

Parameters:

DeviceNumberType Width -The width of the matrix in displays.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.