The ICnrEditEvent class forms the base of the container edit events. These events are dispatched during direct editing in the container. Editing can be started by the user or by program control using the following functions:
Direct editing of a field in the container is not allowed unless the field is set to "editable." Whether the container is editable is controlled by the following styles and member functions
The ICnrEditEvent class and its derived classes provide information about
You can construct and destruct objects of this class.
![]() |
public:
virtual ~ICnrEditEvent()
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
ICnrEditEvent(const IControlEvent& event)
Although you can create objects of this class, typically ICnrEditHandler::dispatchHandlerEvent creates them from an IControlEvent object in response to a direct editing notification.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to query and set the accessible attributes of this class.
![]() |
public:
virtual IContainerColumn* column() const
Returns the column being edited. If the edit is not column-related (for example, a title edit), 0 is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IContainerControl* container() const
Returns the container in which the edit is taking place.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
bool isDetailsData() const
If data in a column of the details view is being edited, true is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
bool isLeftDetails() const
If data in the left column of the details view is being edited, true is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
The native Windows containers (that is, containers constructed without the pmCompatible style) do not support a split bar. There is no right details window in this case.
![]() |
public:
bool isLeftDetailsHeading() const
If the left details heading is being edited, true is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
The native Windows containers (that is, containers constructed without the pmCompatible style) do not support editing of column headings.
![]() |
public:
bool isRightDetails() const
If data in the right column of the details view is being edited, true is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
The native Windows containers (that is, containers constructed without the pmCompatible style) do not support a split bar. There is no right details window in this case.
![]() |
public:
bool isRightDetailsHeading() const
If the right details heading is being edited, true is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
The native Windows containers (that is, containers constructed without the pmCompatible style) do not support editing of column headings.
![]() |
public:
bool isTitleWindow() const
If the title is being edited, true is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
The native Windows containers (that is, containers constructed without the pmCompatible style) do not support editing of container title.
![]() |
public:
virtual IContainerObject* object() const
Returns the object being edited. If the edit is not object-related (for example, a title edit), 0 is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
These functions get information about the text string.
![]() |
protected:
char ** textRef() const
Returns a pointer to the current text pointer for the ICnrBeginEditEvent and ICnrReallocStringEvent events. For ICnrEndEditEvent, a pointer to the new text pointer is returned.
See ICnrBeginEditEvent, ICnrReallocStringEvent and ICnrEndEditEvent for information about those classes.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
protected:
unsigned long textSize() const
Returns the number of bytes in the text string (not counting the NULL termination) for ICnrEndEditEvent and ICnrReallocStringEvent events. Otherwise, 0 is returned.
See ICnrEndEditEvent and ICnrReallocStringEvent for information about those classes.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
virtual ~ICnrEvent()
ICnrEvent(const IControlEvent& event)
virtual ~IControlEvent()
virtual unsigned long controlId() const
IControlEvent(const IControlEvent& event)
IControlEvent(const IEvent& event)
virtual ~IEvent()
IWindowHandle controlHandle() const
virtual IWindow* controlWindow() const
IEvent& decrementOwnerLevels()
virtual IWindow* dispatchingWindow() const
unsigned long eventId() const
IWindowHandle handle() const
IEvent( const IWindowHandle& handle, unsigned long eventId, const IEventParameter1& parameter1, const IEventParameter2& parameter2 )
IEvent( IWindow* window, unsigned long eventId, const IEventParameter1& parameter1, const IEventParameter2& parameter2 )
IEvent(const IEvent& event)
IEvent& operator =(const IEvent& event)
IEventParameter1 parameter1() const
IEventParameter2 parameter2() const
bool passToOwner() const
IEventResult result() const
IEvent& setControlHandle(const IWindowHandle& handle)
IEvent& setDispatchingHandle(const IWindowHandle& handle)
IEvent& setDispatchingWindow(IWindow* window)
IEvent& setHandle(const IWindowHandle& handle)
IEvent& setNumberOfLevels(int levels = - 1)
IEvent& setPassToOwner(bool passOn = true)
IEvent& setResult(bool eventResult)
IEvent& setResult(const IEventResult& eventResult)
virtual IWindow* window() const
unsigned long containerId() const