LibreOffice
LibreOffice 6.2 SDK API Reference
Exported Interfaces | List of all members
SubmitButton Service Reference

specifies a button control which can execute external submissions More...

import"SubmitButton.idl";

Inheritance diagram for SubmitButton:
XSubmission XInterface

Exported Interfaces

interface com::sun::star::form::submission::XSubmission
 allows interception (and vetoing) of submissions triggered by the control. More...
 

Additional Inherited Members

- Public Member Functions inherited from XSubmission
void submit () raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException )
 tells the component to submit data More...
 
void submitWithInteraction ([in] com::sun::star::task::XInteractionHandler aHandler) raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException )
 tells the component to submit data More...
 
void addSubmissionVetoListener ([in] XSubmissionVetoListener listener) raises ( com::sun::star::lang::NoSupportException )
 registers the given listener to be notified when a submission occurs More...
 
void removeSubmissionVetoListener ([in] XSubmissionVetoListener listener) raises ( com::sun::star::lang::NoSupportException )
 revokes a listener which has previously been registered to be notified when a submission occurs More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

specifies a button control which can execute external submissions

The model of the control has to support the com::sun::star::form::component::SubmitButton service.

The control is clickable. When clicked (by mouse or keyboard, or programmatically), the following happens:

  1. Any com::sun::star::form::submission::XSubmissionVetoListeners registered at the component are given the chance to veto the submission.
  2. The model of the control is examined for an external submission object. That is, com::sun::star::form::submission::XSubmissionSupplier::getSubmission() is called at the model.
    If there is such a submission object, its com::sun::star::form::submission::XSubmission::submit() method is invoked.
  3. If there is no external submission, the parent object of the model is examined for the presence of the com::sun::star::form::XSubmit interface. If it is present, it's com::sun::star::form::XSubmit::submit() method is invoked.
    Since the parent object of a submit button can only be a com::sun::star::form::component::Form, this means that SubmitButtons are also able to submit com::sun::star::form::component::HTMLForms.

Exported Interfaces

allows interception (and vetoing) of submissions triggered by the control.


The documentation for this service was generated from the following file: