LibreOffice
LibreOffice 5.3 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Modules | Classes | Enumerations
com::sun::star::form Module Reference

Interfaces for managing forms and controls. More...

Modules

module  binding
 collects functionality for binding form controls to external data sources.
 
module  component
 collects form control model descriptions
 
module  control
 collects form control descriptions
 
module  inspection
 collects services for inspecting form/components
 
module  runtime
 collects functionality needed during a form's runtime, e.g.
 
module  submission
 collects functionality for submitting forms to external data sinks
 
module  validation
 collects functionality to validate form components by help of external validator instances
 

Constant Groups

constants FormComponentType
 These constants specify the class types used to identify a component.
 

Classes

service  ControlFontDialog
 
service  DataAwareControlModel
 is an abstract service for specialized FormControlModels which are data aware and thus can be bound to a data source. More...
 
struct  DatabaseDeleteEvent
 is fired if a database record is going to be deleted. More...
 
struct  DatabaseParameterEvent
 is fired if values for parameters are needed. More...
 
struct  ErrorEvent
 occurs in case of fired database exceptions triggered by a database form. More...
 
service  FormComponent
 specifies a component which can be part of a form. More...
 
service  FormComponents
 specifies the capabilities of a collection of FormComponents. More...
 
service  FormController
 is superseded by com::sun::star::form::runtime::FormController. More...
 
service  FormControllerDispatcher
 is not used anymore, and superseded by com::sun::star::form::runtime::FormController and com::sun::star::form::runtime::FormOperations. More...
 
service  FormControlModel
 specifies a control model within a form. More...
 
service  Forms
 specifies the capabilities of a collection of forms. More...
 
service  PropertyBrowserController
 describes a controller which can be used to browse and modify properties of form controls. More...
 
service  TabOrderDialog
 
interface  XApproveActionBroadcaster
 allows to probably veto actions to be performed on components. More...
 
interface  XApproveActionListener
 can be implemented to listen and probably veto actions to be performed on components. More...
 
interface  XBoundComponent
 specifies a (form) component which is bound to a data source. More...
 
interface  XBoundControl
 allows locking the input on components. More...
 
interface  XChangeBroadcaster
 provides functionality to notify listeners of data changes. More...
 
interface  XChangeListener
 is the listener interface for receiving notifications about data changes. More...
 
interface  XConfirmDeleteBroadcaster
 provides the possibility of receiving an event for confirming deletions of rows in a com::sun::star::form::component::DataForm. More...
 
interface  XConfirmDeleteListener
 allows to register a component for confirming deletions of rows in a com::sun::star::form::component::DataForm. More...
 
interface  XDatabaseParameterBroadcaster
 provides the possibility of receiving an event for configuration of parameters. More...
 
interface  XDatabaseParameterBroadcaster2
 provides the possibility of receiving an event for configuration of parameters. More...
 
interface  XDatabaseParameterListener
 allows to intercept value request for parametrized SQL statements. More...
 
interface  XDeleteListener
 This is the listener interface for receiving "approveDelete" and "deleted" events posted by a database form. More...
 
interface  XErrorBroadcaster
 provides the possibility of receiving database error events. More...
 
interface  XErrorListener
 used to be notified when errors in a database form happen. More...
 
interface  XForm
 identifies a FormComponent as being a (sub-) form. More...
 
interface  XFormComponent
 describes a component which may be part of a form. More...
 
interface  XFormController
 is superseded by com::sun::star::form::runtime::XFormController. More...
 
interface  XFormControllerListener
 allows to be notified when the activation status of a FormController changes. More...
 
interface  XForms
 
interface  XFormsSupplier
 provides the access to a collection of forms. More...
 
interface  XFormsSupplier2
 extends the XFormsSupplier with convenience methods More...
 
interface  XGrid
 provides the possibility of setting and retrieving the position of the current cell in a grid control. More...
 
interface  XGridColumnFactory
 allows to create columns to be added into a grid control model. More...
 
interface  XGridControl
 specifies (some) functionality provided by a grid control (aka table control) More...
 
interface  XGridControlListener
 specifies a listener which is to be notified about state changes in a grid control More...
 
interface  XGridFieldDataSupplier
 provides access to the data of a GridControl More...
 
interface  XGridPeer
 represents the window peer of a GridControl and allows you to set and retrieve the model data. More...
 
interface  XImageProducerSupplier
 provides the access to an image producer. More...
 
interface  XInsertListener
 allows to receive notifications about insertions into a database form. More...
 
interface  XLoadable
 provides functionality to implement objects which may be loaded. More...
 
interface  XLoadListener
 receives load-related events from a loadable object. More...
 
interface  XPositioningListener
 allows to receive notifications about cursor movements into a database form. More...
 
interface  XReset
 provides functionality to reset components to some default values. More...
 
interface  XResetListener
 is the interface for receiving notifications about reset events. More...
 
interface  XRestoreListener
 receives notifications about data being restored. More...
 
interface  XSubmit
 provides functionality to submit data from a component. More...
 
interface  XSubmitListener
 receives notifications about data being submitted. More...
 
interface  XUpdateBroadcaster
 is the broadcaster interface for sending "approveUpdate" and "updated" events. More...
 
interface  XUpdateListener
 used to listen on objects which allow updating their data. More...
 

Enumerations

enum  DataSelectionType { TABLE, QUERY, SQL, SQLPASSTHROUGH }
 describes the type of datasource used for a form. More...
 
enum  FormButtonType { PUSH, SUBMIT, RESET, URL }
 specifies the action to execute when a button is pressed. More...
 
enum  FormSubmitEncoding { URL, MULTIPART, TEXT }
 specify the MIME encoding to be used when form data is submitted. More...
 
enum  FormSubmitMethod { GET, POST }
 specifies how information is sent to a program invoked by submitting a form. More...
 
enum  ListSourceType {
  VALUELIST, TABLE, QUERY, SQL,
  SQLPASSTHROUGH, TABLEFIELDS
}
 describes the kind of data source used to fill the list data of a listbox or a combobox control. More...
 
enum  NavigationBarMode { NONE, CURRENT, PARENT }
 describes in which way the navigation of the records of a database form is performed. More...
 
enum  TabulatorCycle { RECORDS, CURRENT, PAGE }
 specifies how the TAB key should be used in a form. More...
 

Detailed Description

Interfaces for managing forms and controls.

Enumeration Type Documentation

enum DataSelectionType
published

describes the type of datasource used for a form.

Please do not use anymore, this enum is deprecated.

Deprecated:
Enumerator
TABLE 

The control should be filled with the data of a table.

QUERY 

The control should be filled with the results of a database query.

SQL 

The control should be filled with the results of a database statement.

SQLPASSTHROUGH 

The control should be filled with the results of a database statement, which is not evaluated by the database engine.

enum FormButtonType
published

specifies the action to execute when a button is pressed.

See Also
com::sun::star::form::component::CommandButton
Enumerator
PUSH 

requires the button to act like a common push button, means no special action is triggered.

SUBMIT 

When the button is clicked, it performs a submit on its containing form.

RESET 

When the button is clicked, it performs a reset on its containing form.

URL 

When the button is clicked, an URL set for the button is opened.

Specifies to use "application/x-www-form-urlencoded" as submit encoding.

See Also
com::sun::star::form::component::CommandButton::TargetURL
com::sun::star::form::component::CommandButton::TargetFrame

Usually used if the FormSubmitMethod attribute has the value POST.

enum FormSubmitEncoding
published

specify the MIME encoding to be used when form data is submitted.

Enumerator
URL 

When the button is clicked, an URL set for the button is opened.

Specifies to use "application/x-www-form-urlencoded" as submit encoding.

See Also
com::sun::star::form::component::CommandButton::TargetURL
com::sun::star::form::component::CommandButton::TargetFrame

Usually used if the FormSubmitMethod attribute has the value POST.

MULTIPART 

Specifies to use "multipart/form-data" as submit encoding.

Usually used when the form contains a file upload element.

TEXT 

specifies to use "text/plain"

Usually used if the FormSubmitMethod attribute has the value POST and the content should be reviewed as full text.

enum FormSubmitMethod
published

specifies how information is sent to a program invoked by submitting a form.

Enumerator
GET 

specifies to append the input information of a form to the target URL as parameters.

POST 

specifies to send the input information in a data body.

enum ListSourceType
published

describes the kind of data source used to fill the list data of a listbox or a combobox control.

See Also
com::sun::star::form::component::ListBox
com::sun::star::form::component::ComboBox
Enumerator
VALUELIST 

The control should be filled with a list of string values.

TABLE 

The control should be filled with the data of a table.

QUERY 

The control should be filled with the results of a database query.

SQL 

The control should be filled with the results of a database statement.

SQLPASSTHROUGH 

The control should be filled with the results of a database statement, which is not evaluated by the database engine.

TABLEFIELDS 

The control should be filled with the field names of a database table.

enum NavigationBarMode
published

describes in which way the navigation of the records of a database form is performed.

Enumerator
NONE 

no navigation bar is provided and navigation on the current form is only possible with the keyboard (TAB/SHIFT TAB).

Note that when this mode is set, a simultaneous TabulatorCycle value of TabulatorCycle::CURRENT means that you cannot travel between records anymore.

See Also
TabulatorCycle
CURRENT 

a navigation bar is provided and navigation will be performed on the current/active form.

pressing the TAB key from the last control moves the focus to the first control in the tab order of the same record.

This is the default and most often encountered mode.

PARENT 

a navigation bar is provided and navigation will be performed on the parent of the current/active form.

This options is usually used for forms containing an grid control only. In such a form, the control has it's own navigation elements, so there is no need to use the navigation bar for the form, but rather for its parent.

enum TabulatorCycle
published

specifies how the TAB key should be used in a form.

If the last control of a form is focused, and the user pressed the TAB key, there are several possibilities how a FormController should handle this. TabulatorCycle specifies these possibilities.

Note that the TabulatorCycle determines what happens when SHIFT-TAB is pressed on the first control of a form, as well as when TAB is pressed on the last control.

First and last refers to the tabbing order of controls.

See Also
FormControlModel::TabIndex
FormController
Enumerator
RECORDS 

pressing the TAB key from the last control moves the focus to the first control in the tab order of the next record.

CURRENT 

a navigation bar is provided and navigation will be performed on the current/active form.

pressing the TAB key from the last control moves the focus to the first control in the tab order of the same record.

This is the default and most often encountered mode.

PAGE 

pressing the TAB key from the last control of a form moves the focus to the first control of the next form in the tab order.