diff options
Diffstat (limited to 'offapi/com/sun/star/form/XFormController.idl')
| -rw-r--r-- | offapi/com/sun/star/form/XFormController.idl | 65 |
1 files changed, 48 insertions, 17 deletions
diff --git a/offapi/com/sun/star/form/XFormController.idl b/offapi/com/sun/star/form/XFormController.idl index 9cbbd5724..813a83950 100644 --- a/offapi/com/sun/star/form/XFormController.idl +++ b/offapi/com/sun/star/form/XFormController.idl @@ -2,9 +2,9 @@ * * $RCSfile: XFormController.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:04:31 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -80,36 +80,55 @@ //============================================================================= -// DocMerge from xml: interface com::sun::star::form::XFormController -/** provides functionality to control the activation - of forms. - - - - <p>It should represent all controls which belong to a form.</p> +/** provides functionality to control the activation of forms controls. + + <p>There is a duality of forms (<type scope="com::sun::star::form::component">DataForm</type>) + and form controllers. In a document view, for every loaded form there is a form controller which is + responsible for exactly the controls which's models are direct children of the form.<br/> + + In some sense, a form controller is the view representation of a form, like a <em>form control</em> is the + view representation of a <em>form control model</em>.<br/> + + This is also reflected in this interface: If you call + <method scope="com::sun::star::awt">XTabController::getModel</method> on a form controller, the form which + the controller is responsible for will be returned.<br/> + + As always in the model-view-paradigm, there is no way from a model to its controller, mostly, because for + <em>one</em> given form, there is one controller for <em>every</em> view of the document.</p> + + <p>A controller is called <em>active</em> if one of the controls it is responsible for has the focus, + else inactive. To be notified whenever this activation state of a given controller changes, you can + add listeners.</p> + + @see com::sun::star::form::component::Form */ interface XFormController: com::sun::star::awt::XTabController { //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XFormController::getCurrentControl - /** access to the current control may be null. + /** access to the currently active control + + @returns + the currently active control, or <NULL/> if there is no such control */ com::sun::star::awt::XControl getCurrentControl(); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XFormController::addActivateListener - /** adds the specified listener to receive events "formActivated" - and "formDeactivated." + /** adds the specified listener to receive notifications whenever the activation state of + the controller changes. + + @param l + the listener to add. */ [oneway] void addActivateListener( [in] com::sun::star::form::XFormControllerListener l ); //------------------------------------------------------------------------- - // DocMerge from xml: method com::sun::star::form::XFormController::removeActivateListener - /** removes the specified listener so it does not receive any events - from the form controller. + /** removes the specified listener + + @param l + the listener to remove. */ [oneway] void removeActivateListener( [in] com::sun::star::form::XFormControllerListener l ); @@ -122,6 +141,18 @@ interface XFormController: com::sun::star::awt::XTabController /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.4.16.3 2002/07/26 10:00:08 fs + IDL review form layer + + Revision 1.4.16.2 2002/02/19 08:26:14 oj + #96946# parameter,return value and exception description + + Revision 1.4.16.1 2002/02/18 14:49:58 oj + #96946# parameter,return value and exception description + + Revision 1.4 2001/03/16 16:41:23 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.3 2000/11/08 12:42:52 mi moved from api |