### ICnrEditEvent

  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:

  - IContainerControl::editObject
  - IContainerControl::editColumnTitle
  - IContainerControl::editContainerTitle)

  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

  - IContainerControl::readOnly
  - IContainerColumn::readOnly
  - IContainerColumn::readOnlyHeading
  - IContainerObject::enableDataUpdate
  - IContainerObject::disableDataUpdate

  The ICnrEditEvent class and its derived classes provide information about

  - the location in the container where the edit is occuring
  - the contents of the data being edited.

### ICnrEditEvent - Member Functions and Data by Group

### Constructors & Destructor

You can construct and destruct objects of this class.

~ICnrEditEvent

      public:
      virtual ~ICnrEditEvent()

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

ICnrEditEvent

      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.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

### Event Information

Use these members to query and set the accessible attributes of this class.

column

      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.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

container

      public:
      virtual IContainerControl* container() const

  Returns the container in which the edit is taking place.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

isDetailsData

      public:
      bool isDetailsData() const

  If data in a column of the details view is being edited, true is returned.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

isLeftDetails

      public:
      bool isLeftDetails() const

  If data in the left column of the details view is being edited, true is returned.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

Windows Considerations

  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.

isLeftDetailsHeading

      public:
      bool isLeftDetailsHeading() const

  If the left details heading is being edited, true is returned.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

Windows Considerations

  The native Windows containers (that is, containers constructed without the pmCompatible style) do not support editing of column headings.

isRightDetails

      public:
      bool isRightDetails() const

  If data in the right column of the details view is being edited, true is returned.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

Windows Considerations

  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.

isRightDetailsHeading

      public:
      bool isRightDetailsHeading() const

  If the right details heading is being edited, true is returned.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

Windows Considerations

  The native Windows containers (that is, containers constructed without the pmCompatible style) do not support editing of column headings.

isTitleWindow

      public:
      bool isTitleWindow() const

  If the title is being edited, true is returned.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

Windows Considerations

  The native Windows containers (that is, containers constructed without the pmCompatible style) do not support editing of container title.

object

      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.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

### Text

These functions get information about the text string.

textRef

      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.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

textSize

      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.

Supported Platforms

  Windows | OS/2 | AIX
  Yes | Yes | Yes

### ICnrEditEvent - Inherited Member Functions and Data

#### Inherited Public Functions

  ICnrEvent

  -     virtual ~ICnrEvent()

  -     ICnrEvent(const IControlEvent& event)

  IControlEvent

  -     virtual ~IControlEvent()

  -     virtual unsigned long controlId() const

  -     IControlEvent(const IControlEvent& event)

  -     IControlEvent(const IEvent& event)

  IEvent

  -     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

#### Inherited Public Data

  - None

#### Inherited Protected Functions

  ICnrEvent

  -     unsigned long containerId() const

#### Inherited Protected Data

  - None