company logo

ControlContext :: addInputHelp - Add a Input help for a Multiline edit

In order to support user input in an edit field, a selection list can be displayed when detecting specific patterns in the input area. Input help pops up with a selection list that is displayed in the control sControl which must be defined in design class sClassName.

The help control pops up at current cursor position when one of the provided activation strings (sActivate) is recognized as user's input.

Any number of input help controls might be added to a control. When adding several input help controls, activation strings should differ. In order to be able to remove input help controls properly, control names for input help controls should differ.

Return value:  Base context for all database context class ( odaba::DBBaseContext & )

The context refers to a DBBaseContext instance, which is the base class for all database context classes (Property, Instance, ObjectSpace and Database).

Implementation details

ControlContext  :: addInputHelp ( odaba::Property &cProperty, odaba::String &sClassName, odaba::String &sControl, odaba::StringList &sActivate )
  • cProperty - Property handle reference
  • sClassName - Class name

    The class name is the name of an implementation class (usually) defined in the database. Class names must not exceed 40 characters.

    In order to pass no class name, an empty string ( String() ) might be passed.

  • sControl - Control name

    The control name is the name of the control resource as being defined within the parent control.

    "city"         // search city control in current control

    "..city"       // search city control in parent-parent-control

    "address.city" // search city control in subordinated address form

  • sActivate - Input help activation rules

    The string list contains a list of activation strings, which will cause the input help control to pop up, when one of the string patterns has been entered by the user.