Region :: Region - Constructor

Implementation overview

• Create copy
  Region :: Region ( cRegion )
• Create region for current line
  Region :: Region ( cControlContext )
• Create an empty region
  Region :: Region (  )
• Create region by identifier
  Region :: Region ( cControlContext, iRegionID )
• Create region by name
  Region :: Region ( cControlContext, sResource )
• Create subregion by name
  Region :: Region ( cRegion, sResource )
• Create subregion by identifier
  Region :: Region ( cRegion, iRegionID )

Implementation details

1. Create copy
   Region  :: Region ( odabagui::Region &cRegion )
   

   The function creates a copy from the region object passed in cRegion .

   • cRegion - - internal feature (not documented)
to list
2. Create region for current line
   Region  :: Region ( odabagui::ControlContext &cControlContext )
   

   The function creates the region for the current line in the control passed as rControlContext . When the current region is not available, the region identifier remains 0.

   ... fragment ( ControlContext &context ) {

     Region   reg(context);

     if ( !reg.id() )

       context.project().output("no current region available");

     else

     ; // do somethng ...

   }

   • cControlContext - Control context

     ControlContext classes are created for field ( ADK_Field ) as well as for control ( ADK_FieldControl ) resources.

     When referring a field resource, the field context will overload the context implemented for the subordinated field control (control context).

to list
3. Create an empty region
   Region  :: Region (  )
   

   The function creates an empty region object, which might be filled later. In order to access region properties, either the region name or the region identifier has to be set before.

to list
4. Create region by identifier
   Region  :: Region ( odabagui::ControlContext &cControlContext, int64 iRegionID )
   

   The function creates a region object referring to the region with the identifier passed in iRegionId . In order to get the top region for a control, 0 has to be passed as region identifier.

   The region identifier must refer to a valid region in the control passed in rControlContext . The function throws an exception when the identifier passed in not 0 and does not refer to a valid region.

   • cControlContext - Control context

     ControlContext classes are created for field ( ADK_Field ) as well as for control ( ADK_FieldControl ) resources.

     When referring a field resource, the field context will overload the context implemented for the subordinated field control (control context).

   • iRegionID - Region identification

     The region identifier is either the resource identity for the region definition (in case the region has been created from an external resource defined in a resource database) or the internal column identifier returned from the ControlContext::addRegion() function.

to list
5. Create region by name
   Region  :: Region ( odabagui::ControlContext &cControlContext, odaba::String &sResource )
   

   The function creates a region object referring to the region with the name passed in sResource .

   The region name must refer to a valid region in the control passed in rControlContext . The function throws an exception when the name passed does not refer to a valid region.

   • cControlContext - Control context

     ControlContext classes are created for field ( ADK_Field ) as well as for control ( ADK_FieldControl ) resources.

     When referring a field resource, the field context will overload the context implemented for the subordinated field control (control context).

   • sResource - Name of resoure

     "ok_button"        // button in the current window

     "address.street"   // line edit in the address subwindow

     ".name"            // line edit in the upper control (window)

to list
6. Create subregion by name
   Region  :: Region ( odabagui::Region &cRegion, odaba::String &sResource )
   

   The function creates a region object referring to a sub region region with the name passed in sResource .

   The region name must refer to a valid sub region of the region passed in cRegion . The function throws an exception when the name passed does not refer to a valid sub region.

   • cRegion - - internal feature (not documented)
   • sResource - Name of resoure

     "ok_button"        // button in the current window

     "address.street"   // line edit in the address subwindow

     ".name"            // line edit in the upper control (window)

to list
7. Create subregion by identifier
   Region  :: Region ( odabagui::Region &cRegion, int64 iRegionID )
   

   The function creates a region object referring to a sub region region with the identifier passed in iRegionID .

   The region identifier must refer to a valid sub region of the region passed in cRegion . The function throws an exception when the identifier passed does not refer to a valid sub region.

   • cRegion - - internal feature (not documented)
   • iRegionID - Region identification

     The region identifier is either the resource identity for the region definition (in case the region has been created from an external resource defined in a resource database) or the internal column identifier returned from the ControlContext::addRegion() function.

to list