Class Hierarchy
IAcPpAcadInput
C++
class IAcPpAcadInput : public IUnknown;
File
acpp.h
Description
This interface is for internal use only.
The IAcPpAcadInput interface defines methods that allow modeless dialogs to acquire input using the AutoCAD acedGetXXX() acquisition methods. It allows clients to provide the parameters that would normally be passed to the acedGetXXX() methods and to acedInitGet(). ActiveX controls hosted by the Property Palette Inspector that need to obtain input using the AutoCAD graphics area or command line are typical clients of this interface.
The AcPpAcadInput co-class implements this interface for the Property Palette. The interface could be re-used by other applications. The co-class provides the following key features:
- It uses the AutoCAD editor and AcEdInputPointMonitor methods to receive callbacks as data is provided by the user, forwarding these messages as IPropertyNotifySink::OnChanged() events to connected listeners. By monitoring these events, clients can update the representation of the data as it is input by the user.
- It supports data acquisition while a command is in progress by transparently obtaining the data. This support is limited to situations in which the current editor state supports transparent commands.
Clients typically make use of the AcPpAcadInput co-class as follows:
- To instantiate an AcPpAcadInput object and get its IAcPpAcadInput interface.
- To set properties on the object describing how the input should be obtained. This includes the type of input to obtain (such as point, angle, distance, or string), prompt strings, crOnly flags, and acedInitGet() parameters.
- To connect an IPropertyNotifySink object to the AcPpAcadInput instance in order to receive callback notifications as the object acquires input and be notified when the input has been obtained or the action aborted by the use.
- To call the IAcPpAcadInput::DoPrompt() method to start the prompt sequence.
- To wait for callbacks, checking the IAcPpAcadInput::Status property and, optionally, the IAcPpAcadInput::Value property for updated values. The IAcPpAcadInput::Status property remains StatusPrompting as long as the object is obtaining input. When the object obtains the desired input, or when the user aborts the operation, the IAcPpAcadInput::Status property changes to reflect the final status of the request (such as StatusRTNORM or StatusRTCAN). At this time, it is possible to obtain the final value, if any, from the IAcPpAcadInput::Value property.
- To disconnect the IPropertyNotifySink listener and release the AcPpAcadInput object.