Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
None.
Inherited By:
TDisplayDeviceConfiguration
Purpose:
This is the base class for examining and changing the common video device configuration settings. This class implements the mechanism for video device configuration updates. However, the class itself does not actually do anything to the configuration settings. Commands that are added are deleted after their use.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
All concrete and specific configuration change classes are derived from this class. Classes deriving from TBaseDisplayDeviceConfiguration should add their own member functions for setting custom display change commands. Then the derived type uses the AddCommand member function to add the TConfigurationCommandProtocol commands to the internal list of configuration change commands. For this reason it is not necessary to override the AddCommand member function. The DoConfigurationChanges member function of this class is then used to actually do the configuration changes. Therefore derived types need not override the DoConfigurationChanges member function.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
void DoConfigurationChanges ()
Interface Category:
API.
Purpose:
Causes all configuration changes queued up to occur.
Calling Context:
Called by client after requesting all changes.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
- TBaseDisplayDeviceConfiguration (TDisplayDeviceHandle & displayToChange)
- TBaseDisplayDeviceConfiguration (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:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual ~ TBaseDisplayDeviceConfiguration ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
void AddCommand (TConfigurationCommandProtocol * theCmd, const DeviceNumberType devNum =0)
Interface Category:
API.
Purpose:
Adds a configuration change command to internal list of changes.
Calling Context:
Called by a derived class to queue up a single configuration change.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual long GetNumberOfDisplays() const
Interface Category:
API.
Purpose:
Returns the number of video displays that can be configured.
Calling Context:
Called by a derived class to get the number of displays for a configuration change.
Parameters:
Return Value:
Returns a long value for the number of displays.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
TDisplayDeviceHandle * GetDevice(const DeviceNumberType)
Interface Category:
API.
Purpose:
Gets a pointer to the specified video device display.
Calling Context:
Called by a derived class to get a pointer to the video device display.
Parameters:
- const DeviceNumberType -The constant that references the particular video device display.
Return Value:
Returns a pointer to the display device.
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.
Copyright©1995 Taligent,Inc. All rights reserved.