diff options
| author | Michael Stahl <mstahl@redhat.com> | 2013-04-27 21:58:51 +0200 |
|---|---|---|
| committer | Michael Stahl <mstahl@redhat.com> | 2013-06-04 12:01:00 +0200 |
| commit | 9f12a9da8d91364d4d0865021adbe62bfa09148c (patch) | |
| tree | a74d3d9213f950fff68bca5ba07662e15b82d217 /offapi/com/sun/star/form | |
| parent | 944eb9902788d8afec9e3f0f65d3b680041e039b (diff) | |
*api: convert <type scope="bar">Foo</type>
This looks much better now.
sed -i 's,<type scope="\([^"]*\)">\([^<]\+\)</type>,\1::\2,g'
Change-Id: I94cd0f93afa89855b62dadeb229d2b2e1775cd80
Diffstat (limited to 'offapi/com/sun/star/form')
85 files changed, 207 insertions, 207 deletions
diff --git a/offapi/com/sun/star/form/DataAwareControlModel.idl b/offapi/com/sun/star/form/DataAwareControlModel.idl index 21219f01067c..803d5f3b1f52 100644 --- a/offapi/com/sun/star/form/DataAwareControlModel.idl +++ b/offapi/com/sun/star/form/DataAwareControlModel.idl @@ -39,9 +39,9 @@ <p>The connection between a data-aware control model and a form whose data the control should display is made by parentship relations. The parent of a data-aware - control model (see <type scope="com::sun::star::container">XChild</type>, inherited + control model (see com::sun::star::container::XChild, inherited via the FormControlModel and FormComponent services) has - always to be a <type scope="com::sun::star::form::component">DataForm</type>.</p> + always to be a com::sun::star::form::component::DataForm.</p> */ published service DataAwareControlModel { @@ -69,18 +69,18 @@ published service DataAwareControlModel <p>In the context of a control model which is data-aware, the semantics of <em>default value</em> (see XReset) is as follows:<br/> - If (and only if) the control is valid bound to a column of it's <type scope="com::sun::star::form::component">DataForm</type>, and the form + If (and only if) the control is valid bound to a column of it's com::sun::star::form::component::DataForm, and the form is not positioned on a new record (see <member scope="com::sun::star::sdb">RowSet::IsNew</member>), then <member>XReset::reset</member> does not reset the model's value to it's default value, but uses the underlying column value.<br/> In all other cases, the model is reset to the default value as specified by the respective property.</p> - <p>For an example, have a look at the <type scope="com::sun::star::form::component">TextField</type>. It inherits + <p>For an example, have a look at the com::sun::star::form::component::TextField. It inherits the <member scope="com::sun::star::awt">UnoControlEditModel::Text</member> property from the underlying service, and additionally specifies the <member scope="com::sun::star::form::component">TextField::DefaultText</member>. </p> - <p>In the context of a <type scope="com::sun::star::form::component">DataForm</type>, controls are + <p>In the context of a com::sun::star::form::component::DataForm, controls are automatically reset when one of the following applies <ul><li>The form is reset by invoking it's XReset interface.</li> <li>The form moves to a new record.</li> @@ -94,7 +94,7 @@ published service DataAwareControlModel /** specifies the name of the bound database field. <p>This property makes sense in the <em>context</em> of the control model only. Normally, a control model - is a child of a <type scope="com::sun::star::form::component">DataForm</type>, which is bound + is a child of a com::sun::star::form::component::DataForm, which is bound to a higher level object such as a table or query - more general, a result set.<br/> This member here describes the column of this result set which the control should act for.</p> @@ -120,7 +120,7 @@ published service DataAwareControlModel /** references to the cursor field to which the control is bound. <p>Applies only if the form the control model belongs to is loaded and the control is valid bound. - The referenced field supports the <type scope="com::sun::star::sdb">Column</type> service. + The referenced field supports the com::sun::star::sdb::Column service. </p> @see DataAwareControlModel::DataField */ @@ -132,31 +132,31 @@ published service DataAwareControlModel property. <br/> A very common design method for forms is to group a data aware control with a label control, with the latter describing the content of the former. For instance, you may have a - <type scope="com::sun::star::form::component">TextField</type>, which is bound to the e-mail + com::sun::star::form::component::TextField, which is bound to the e-mail column of your data source. Then you will probably add a - <type scope="com::sun::star::form::component">FixedText</type> whose label is "E-Mail", + com::sun::star::form::component::FixedText whose label is "E-Mail", and associate it with the TextField by setting it as <member>LabelControl</member>.<br/> Now if you imagine a component offering data search in a form, this component will examine - the <member>LabelControl</member> property, find the <type scope="com::sun::star::form::component">FixedText</type>, - examine it's label, and use this label to refer to the <type scope="com::sun::star::form::component">TextField</type>. + the <member>LabelControl</member> property, find the com::sun::star::form::component::FixedText, + examine it's label, and use this label to refer to the com::sun::star::form::component::TextField. </p> <p>When setting the property, a number of constraints apply: <ul> <li>The object which is to be set has to support the following interfaces - <ul><li><type scope="com::sun::star::awt">XControlModel</type></li> - <li><type scope="com::sun::star::lang">XServiceInfo</type></li> - <li><type scope="com::sun::star::beans">XPropertySet</type></li> - <li><type scope="com::sun::star::container">XChild</type></li> + <ul><li>com::sun::star::awt::XControlModel</li> + <li>com::sun::star::lang::XServiceInfo</li> + <li>com::sun::star::beans::XPropertySet</li> + <li>com::sun::star::container::XChild</li> </ul> </il> <li>It has to be a part of the same document as the model who's property is to be modified.</il> <li>Additionally, the support of a special service, indicating that the model is of the right type, is required. Which kind of service is in the request depends on the type of the control model.<br/> - For instance, text fields (<type scope="com::sun::star::form::component">TextField</type>) can be - labeled by label controls only (<type scope="com::sun::star::form::component">FixedText</type>), - and radio buttons (<type scope="com::sun::star::form::component">RadioButton</type>) can be labeled - by group boxes (<type scope="com::sun::star::form::component">GroupBox</type>) only. + For instance, text fields (com::sun::star::form::component::TextField) can be + labeled by label controls only (com::sun::star::form::component::FixedText), + and radio buttons (com::sun::star::form::component::RadioButton) can be labeled + by group boxes (com::sun::star::form::component::GroupBox) only. </li> </ul> </p> diff --git a/offapi/com/sun/star/form/DatabaseParameterEvent.idl b/offapi/com/sun/star/form/DatabaseParameterEvent.idl index af49fd0cf023..344fa2543b61 100644 --- a/offapi/com/sun/star/form/DatabaseParameterEvent.idl +++ b/offapi/com/sun/star/form/DatabaseParameterEvent.idl @@ -34,10 +34,10 @@ published struct DatabaseParameterEvent: com::sun::star::lang::EventObject { /** specifies the list of parameters which are required for opening a result set. - <p>Usually, a <type scope="com::sun::star::form::component">DataForm</type> fires this + <p>Usually, a com::sun::star::form::component::DataForm fires this event when loading the form requires parameters to be filled in.</p> - <p>Every parameter object supports the <type scope="com::sun::star::beans">XPropertySet</type> + <p>Every parameter object supports the com::sun::star::beans::XPropertySet interface, and at least the properties <em>Name</em> and <em>Value</em></p> @see com::sun::star::sdb::RowSet diff --git a/offapi/com/sun/star/form/FormComponent.idl b/offapi/com/sun/star/form/FormComponent.idl index 8d3aa13c50cd..d81cdc554b51 100644 --- a/offapi/com/sun/star/form/FormComponent.idl +++ b/offapi/com/sun/star/form/FormComponent.idl @@ -70,7 +70,7 @@ published service FormComponent properties</em>.</p> <p>Additionally, you can add more properties to the component as needed, - using the <type scope="com::sun::star::beans">XPropertyContainer</type> interface. + using the com::sun::star::beans::XPropertyContainer interface. Those properties are called <em>dynamic properties</em>.</p> <p>Dynamic properties are not evaluated by the component itself, @@ -90,7 +90,7 @@ published service FormComponent /** the name of the component. <p>Note that the name accessed here is the same as when using the - <type scope="com::sun::star::container">XNamed</type> interface.</p> + com::sun::star::container::XNamed interface.</p> */ [property] string Name; diff --git a/offapi/com/sun/star/form/FormComponentType.idl b/offapi/com/sun/star/form/FormComponentType.idl index 7d7dc4b61638..a35286b7dee2 100644 --- a/offapi/com/sun/star/form/FormComponentType.idl +++ b/offapi/com/sun/star/form/FormComponentType.idl @@ -117,7 +117,7 @@ published constants FormComponentType */ const short SPINBUTTON = 21; - /** specifies a control which provides controller functionality for the <type scope="com::sun::star::form::component">DataForm</type> + /** specifies a control which provides controller functionality for the com::sun::star::form::component::DataForm it belongs to, such as functionality to navigate or filter this form. */ const short NAVIGATIONBAR = 22; diff --git a/offapi/com/sun/star/form/FormComponents.idl b/offapi/com/sun/star/form/FormComponents.idl index 17dd0e9b3a98..5e0f8188a924 100644 --- a/offapi/com/sun/star/form/FormComponents.idl +++ b/offapi/com/sun/star/form/FormComponents.idl @@ -61,10 +61,10 @@ published service FormComponents <p>The interface allows managing of scripts associated with dependent components, accessed by index. However, as a client of the FormComponents service, there's no need to bother with - the container aspect of the <type scope="com::sun::star::script">XEventAttacherManager</type> + the container aspect of the com::sun::star::script::XEventAttacherManager directly. A FormComponents container will automatically synchronize the elements you put into it with the scripting information obtained at the - <type scope="com::sun::star::script">XEventAttacherManager</type> interface.</p> + com::sun::star::script::XEventAttacherManager interface.</p> <p>For instance, at any time you can obtain the events associated with the <code>n</code><super>th</super> element in the form components by calling diff --git a/offapi/com/sun/star/form/FormController.idl b/offapi/com/sun/star/form/FormController.idl index 4bf2828cc3e1..137bd6eafb6c 100644 --- a/offapi/com/sun/star/form/FormController.idl +++ b/offapi/com/sun/star/form/FormController.idl @@ -45,7 +45,7 @@ module runtime { }; -/** is superseded by <type scope="com::sun::star::form::runtime">FormController</type>. +/** is superseded by com::sun::star::form::runtime::FormController. @deprecated */ published service FormController diff --git a/offapi/com/sun/star/form/FormControllerDispatcher.idl b/offapi/com/sun/star/form/FormControllerDispatcher.idl index a5f2b40de145..159d787da443 100644 --- a/offapi/com/sun/star/form/FormControllerDispatcher.idl +++ b/offapi/com/sun/star/form/FormControllerDispatcher.idl @@ -25,8 +25,8 @@ module com { module sun { module star { module form { -/** is not used anymore, and superseded by <type scope="com::sun::star::form::runtime">FormController</type> and - <type scope="com::sun::star::form::runtime">FormOperations</type>. +/** is not used anymore, and superseded by com::sun::star::form::runtime::FormController and + com::sun::star::form::runtime::FormOperations. @deprecated */ diff --git a/offapi/com/sun/star/form/Forms.idl b/offapi/com/sun/star/form/Forms.idl index eccec74e7a7b..4619f3f36a4f 100644 --- a/offapi/com/sun/star/form/Forms.idl +++ b/offapi/com/sun/star/form/Forms.idl @@ -29,7 +29,7 @@ <p>Basically, a Forms is a FormComponents, with the additional restriction that the contained elements support the - <type scope="com::sun::star::form::component">Form</type> service.</p> + com::sun::star::form::component::Form service.</p> @see com::sun::star::form::component::Form */ diff --git a/offapi/com/sun/star/form/PropertyBrowserController.idl b/offapi/com/sun/star/form/PropertyBrowserController.idl index 1ef3164d82e2..56de59e46313 100644 --- a/offapi/com/sun/star/form/PropertyBrowserController.idl +++ b/offapi/com/sun/star/form/PropertyBrowserController.idl @@ -31,7 +31,7 @@ /** describes a controller which can be used to browse and modify properties of form controls. - <p>The controller can be plugged into an <type scope="com::sun::star::frame">XFrame</type>, and will + <p>The controller can be plugged into an com::sun::star::frame::XFrame, and will provide a visual component for inspecting control properties. This means it allows to interactively control several aspects of a FormControlModel or DataAwareControlModel, such as it's data binding, it's layout, and it's event binding</p> @@ -68,8 +68,8 @@ @deprecated <p>Note that nowadays, this service is only a legacy wrapper using the - <type scope="com::sun::star::inspection">ObjectInspector</type> and the - <type scope="com::sun::star::form::inspection">DefaultFormComponentInspectorModel</type> services, and knitting them together.</p> + com::sun::star::inspection::ObjectInspector and the + com::sun::star::form::inspection::DefaultFormComponentInspectorModel services, and knitting them together.</p> */ published service PropertyBrowserController @@ -102,7 +102,7 @@ published service PropertyBrowserController /** ensures the basic functionality for a controller. <p>With supporting this interface, the component is able to operate in (and provide content - for) an <type scope="com::sun::star::frame">XFrame</type>.</p> + for) an com::sun::star::frame::XFrame.</p> */ interface com::sun::star::frame::XController; diff --git a/offapi/com/sun/star/form/XApproveActionBroadcaster.idl b/offapi/com/sun/star/form/XApproveActionBroadcaster.idl index 88ecbef06311..f76ebb7e31f5 100644 --- a/offapi/com/sun/star/form/XApproveActionBroadcaster.idl +++ b/offapi/com/sun/star/form/XApproveActionBroadcaster.idl @@ -32,7 +32,7 @@ <p> Usually, a component which supports the XApproveActionBroadcaster interface implements - <type scope="com::sun::star::awt">XActionListener</type> as well.</p> + com::sun::star::awt::XActionListener as well.</p> */ published interface XApproveActionBroadcaster: com::sun::star::uno::XInterface { diff --git a/offapi/com/sun/star/form/XConfirmDeleteBroadcaster.idl b/offapi/com/sun/star/form/XConfirmDeleteBroadcaster.idl index fb545c2090ea..0d66ce031750 100644 --- a/offapi/com/sun/star/form/XConfirmDeleteBroadcaster.idl +++ b/offapi/com/sun/star/form/XConfirmDeleteBroadcaster.idl @@ -29,7 +29,7 @@ /** provides the possibility of receiving an event for confirming deletions of - rows in a <type scope="com::sun::star::form::component">DataForm</type>. + rows in a com::sun::star::form::component::DataForm. @see XConfirmDeleteListener */ diff --git a/offapi/com/sun/star/form/XConfirmDeleteListener.idl b/offapi/com/sun/star/form/XConfirmDeleteListener.idl index 74cf330700bb..f7e0ce2f632a 100644 --- a/offapi/com/sun/star/form/XConfirmDeleteListener.idl +++ b/offapi/com/sun/star/form/XConfirmDeleteListener.idl @@ -28,7 +28,7 @@ /** allows to register a component for confirming deletions of - rows in a <type scope="com::sun::star::form::component">DataForm</type>. + rows in a com::sun::star::form::component::DataForm. @see XConfirmDeleteBroadcaster */ diff --git a/offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl b/offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl index 868c7e68fe66..eec7b9c4b265 100644 --- a/offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl +++ b/offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl @@ -31,7 +31,7 @@ /** provides the possibility of receiving an event for configuration of parameters. <p>This interface is usually implemented by components which are to execute a statement, and may need parameter information. For example, the - <type scope="com::sun::star::form::component">DataForm</type> is such a component. When it is + com::sun::star::form::component::DataForm is such a component. When it is bound to a statement which contains parameters, or to a query which is based upon a parametrized statement, it needs values to fill in the parameters with actual values when it is being loaded. One method to gather these values is calling the XDatabaseParameterListener listeners, which diff --git a/offapi/com/sun/star/form/XDeleteListener.idl b/offapi/com/sun/star/form/XDeleteListener.idl index 3a073b633e7c..ec4cc70494ad 100644 --- a/offapi/com/sun/star/form/XDeleteListener.idl +++ b/offapi/com/sun/star/form/XDeleteListener.idl @@ -35,7 +35,7 @@ record.</p> <p>Please do <em><b>not</b></em> use anymore, this interface is superseded - by <type scope="com::sun::star::form">XConfirmDeleteListener</type>.</p> + by com::sun::star::form::XConfirmDeleteListener.</p> @deprecated */ diff --git a/offapi/com/sun/star/form/XErrorBroadcaster.idl b/offapi/com/sun/star/form/XErrorBroadcaster.idl index 5cba5cf08019..cf8212bd4368 100644 --- a/offapi/com/sun/star/form/XErrorBroadcaster.idl +++ b/offapi/com/sun/star/form/XErrorBroadcaster.idl @@ -31,7 +31,7 @@ /** provides the possibility of receiving database error events. <p>Please do <em><b>not</b></em> use anymore, this interface is superseded - by <type scope="com::sun::star::sdb">XSQLErrorBroadcaster</type>.</p> + by com::sun::star::sdb::XSQLErrorBroadcaster.</p> @deprecated */ diff --git a/offapi/com/sun/star/form/XErrorListener.idl b/offapi/com/sun/star/form/XErrorListener.idl index d9d184aa781e..ca14977232ed 100644 --- a/offapi/com/sun/star/form/XErrorListener.idl +++ b/offapi/com/sun/star/form/XErrorListener.idl @@ -35,7 +35,7 @@ configure the error handling of a database form.</p> <p>Please do <em><b>not</b></em> use anymore, this interface is superseded - by <type scope="com::sun::star::sdb">XSQLErrorListener</type>.</p> + by com::sun::star::sdb::XSQLErrorListener.</p> @deprecated */ diff --git a/offapi/com/sun/star/form/XFormController.idl b/offapi/com/sun/star/form/XFormController.idl index 641a7ddd3804..43c3fb7086d9 100644 --- a/offapi/com/sun/star/form/XFormController.idl +++ b/offapi/com/sun/star/form/XFormController.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module form { -/** is superseded by <type scope="com::sun::star::form::runtime">XFormController</type>. +/** is superseded by com::sun::star::form::runtime::XFormController. @deprecated */ published interface XFormController: com::sun::star::awt::XTabController diff --git a/offapi/com/sun/star/form/XForms.idl b/offapi/com/sun/star/form/XForms.idl index 577c1b699963..14f8c52aef88 100644 --- a/offapi/com/sun/star/form/XForms.idl +++ b/offapi/com/sun/star/form/XForms.idl @@ -58,10 +58,10 @@ published interface XForms <p>The interface allows managing of scripts associated with dependent components, accessed by index. However, as a client of the FormComponents service, there's no need to bother with - the container aspect of the <type scope="com::sun::star::script">XEventAttacherManager</type> + the container aspect of the com::sun::star::script::XEventAttacherManager directly. A FormComponents container will automatically synchronize the elements you put into it with the scripting information obtained at the - <type scope="com::sun::star::script">XEventAttacherManager</type> interface.</p> + com::sun::star::script::XEventAttacherManager interface.</p> <p>For instance, at any time you can obtain the events associated with the <code>n</code><super>th</super> element in the form components by calling diff --git a/offapi/com/sun/star/form/XGrid.idl b/offapi/com/sun/star/form/XGrid.idl index 58c2fc0c747b..1d35cde518d9 100644 --- a/offapi/com/sun/star/form/XGrid.idl +++ b/offapi/com/sun/star/form/XGrid.idl @@ -31,9 +31,9 @@ <p>Note that a grid control does not allow free control over the current row: In such a control, every line represents a row of data of the underlying - <type scope="com::sun::star::form::component">DataForm</type>. Thus, the <em>current + com::sun::star::form::component::DataForm. Thus, the <em>current row</em> of the grid control always equals the current row of the - <type scope="com::sun::star::form::component">DataForm</type>, and can be affected only + com::sun::star::form::component::DataForm, and can be affected only by changing the latter.<br/> The current column of a grid control, whoever, can be freely controlled.</p> diff --git a/offapi/com/sun/star/form/XGridFieldDataSupplier.idl b/offapi/com/sun/star/form/XGridFieldDataSupplier.idl index 2923ad54bbbb..fa95fd11999e 100644 --- a/offapi/com/sun/star/form/XGridFieldDataSupplier.idl +++ b/offapi/com/sun/star/form/XGridFieldDataSupplier.idl @@ -34,7 +34,7 @@ <p>This interface allows to retrieve data even for rows which are not current, which is quite useful, as normally, you can't affect the current row in a grid control without moving the cursor of the underlying - <type scope="com::sun::star::form::component">DataForm</type>.</p> + com::sun::star::form::component::DataForm.</p> @see XGrid @see com::sun::star::form::control::GridControl diff --git a/offapi/com/sun/star/form/XInsertListener.idl b/offapi/com/sun/star/form/XInsertListener.idl index ee4a9e8f4efd..4965895d8ff9 100644 --- a/offapi/com/sun/star/form/XInsertListener.idl +++ b/offapi/com/sun/star/form/XInsertListener.idl @@ -31,9 +31,9 @@ /** allows to receive notifications about insertions into a database form. <p>Please do <em><b>not</b></em> use anymore, this interface is deprecated, and - superseded by functionality from the <type scope="com::sun::star::form::component">DataForm</type> - service, as well as the <type scope="com::sun::star::sdbc">XRowSetListener</type> and - <type scope="com::sun::star::sdb">XRowSetApproveListener</type> interfaces.</p> + superseded by functionality from the com::sun::star::form::component::DataForm + service, as well as the com::sun::star::sdbc::XRowSetListener and + com::sun::star::sdb::XRowSetApproveListener interfaces.</p> @deprecated */ diff --git a/offapi/com/sun/star/form/XPositioningListener.idl b/offapi/com/sun/star/form/XPositioningListener.idl index 7e47a8344929..c8d81aed0e33 100644 --- a/offapi/com/sun/star/form/XPositioningListener.idl +++ b/offapi/com/sun/star/form/XPositioningListener.idl @@ -31,8 +31,8 @@ /** allows to receive notifications about cursor movements into a database form. <p>Please do <em><b>not</b></em> use anymore, this interface is deprecated, and - superseded by functionality from the <type scope="com::sun::star::form::component">DataForm</type> - service, as well as the <type scope="com::sun::star::sdbc">XRowSetListener</type>.</p> + superseded by functionality from the com::sun::star::form::component::DataForm + service, as well as the com::sun::star::sdbc::XRowSetListener.</p> @deprecated */ diff --git a/offapi/com/sun/star/form/XRestoreListener.idl b/offapi/com/sun/star/form/XRestoreListener.idl index d031c1b87fb8..cfd40d25ffc7 100644 --- a/offapi/com/sun/star/form/XRestoreListener.idl +++ b/offapi/com/sun/star/form/XRestoreListener.idl @@ -35,8 +35,8 @@ without saving the data. After restoring, the user operates on the original data.</p> <p>Please do <em><b>not</b></em> use anymore, this interface is deprecated, and - superseded by functionality from the <type scope="com::sun::star::form::component">DataForm</type> - and <type scope="com::sun::star::sdb">RowSet</type> services</p> + superseded by functionality from the com::sun::star::form::component::DataForm + and com::sun::star::sdb::RowSet services</p> @deprecated */ diff --git a/offapi/com/sun/star/form/XSubmit.idl b/offapi/com/sun/star/form/XSubmit.idl index 91ad7ec20d90..3ec4a4008b84 100644 --- a/offapi/com/sun/star/form/XSubmit.idl +++ b/offapi/com/sun/star/form/XSubmit.idl @@ -34,7 +34,7 @@ /** provides functionality to submit data from a component. - <p>Usually, this is used by <type scope="com::sun::star::form::component">HTMLForm</type>s. + <p>Usually, this is used by com::sun::star::form::component::HTMLForms. <p>See the <A href="http://www.w3.org/TR/1999/REC-html401-19991224/interact/forms.html#h-17.13">HTML specification</A> to learn about submitting forms.</p> diff --git a/offapi/com/sun/star/form/XSubmitListener.idl b/offapi/com/sun/star/form/XSubmitListener.idl index eb68f4d1b562..87f6cb3df180 100644 --- a/offapi/com/sun/star/form/XSubmitListener.idl +++ b/offapi/com/sun/star/form/XSubmitListener.idl @@ -36,7 +36,7 @@ @see XSubmit @deprecated - This interface is superseded by the <type scope="com::sun::star::form::submission">XSubmissionVetoListener</type> + This interface is superseded by the com::sun::star::form::submission::XSubmissionVetoListener interface. New implementations should use the latter, if possible. */ published interface XSubmitListener: com::sun::star::lang::XEventListener diff --git a/offapi/com/sun/star/form/binding/BindableControlModel.idl b/offapi/com/sun/star/form/binding/BindableControlModel.idl index 1c808d143f67..8c6ca0bf6e03 100644 --- a/offapi/com/sun/star/form/binding/BindableControlModel.idl +++ b/offapi/com/sun/star/form/binding/BindableControlModel.idl @@ -34,7 +34,7 @@ service BindableControlModel /** specifies the basic functionality for a form control model <p>Via this service, bindable control models inherit the - <type scope="com::sun::star::util">XCloneable</type> interface.<br/> + com::sun::star::util::XCloneable interface.<br/> If an bindable control model, at which a binding has been established (via <member>XBindableValue::setValueBinding</member>), is being cloned, then the binding is also established at the clone. Effectively, this means that diff --git a/offapi/com/sun/star/form/binding/BindableDataAwareControlModel.idl b/offapi/com/sun/star/form/binding/BindableDataAwareControlModel.idl index 89a5a9b51534..31a3da3710a3 100644 --- a/offapi/com/sun/star/form/binding/BindableDataAwareControlModel.idl +++ b/offapi/com/sun/star/form/binding/BindableDataAwareControlModel.idl @@ -27,34 +27,34 @@ module com { module sun { module star { module form { module binding { -/** is a specialization of the <type scope="com::sun::star::form">DataAwareControlModel</type> +/** is a specialization of the com::sun::star::form::DataAwareControlModel which additionally supports binding to external value suppliers. <p>Control models usually have some kind of value property, which reflects the very current content of the controls associated with this model. For instance, for an - <type scope="com::sun::star::form::component">TextField</type>, this would be the + com::sun::star::form::component::TextField, this would be the <member scope="com::sun::star::awt">UnoControlEditModel::Text</member> property of the base - service. Similarly, a <type scope="com::sun::star::form::component">CheckBox</type> has + service. Similarly, a com::sun::star::form::component::CheckBox has a property <member scope="com::sun::star::awt">UnoControlCheckBoxModel::State</member>, which reflects the current check state.</p> - <p>Usual <type scope="com::sun::star::form">DataAwareControlModel</type>s can be bound to - a column of a <type scope="com::sun::star::form::component">DataForm</type>, and exchange + <p>Usual com::sun::star::form::DataAwareControlModels can be bound to + a column of a com::sun::star::form::component::DataForm, and exchange their content with such a column.<br/> - In particular, when the <type scope="com::sun::star::form::component">DataForm</type> + In particular, when the com::sun::star::form::component::DataForm is moved to a different record, then the bound control model is updated with the value of it's column in this particular row.<br/> On the other hand, when any change in the control model (e.g. resulting from a user entering data in a control associated with the control model) is committed (<member scope="com::sun::star::form">XBoundComponent::commit</member>), then the actual data of the control model is written into the associated - <type scope="com::sun::star::form::component">DataForm</type> column.</p> + com::sun::star::form::component::DataForm column.</p> <p>BindableDataAwareControlModel's additionally support an alternative value binding, which forces them to exchange their value with another foreign instance. In some sense, they are an abstraction of the data aware control models, which only support a specialized, hard-coded value binding (namely the binding to a - <type scope="com::sun::star::form::component">DataForm</type> column).</p> + com::sun::star::form::component::DataForm column).</p> <p>For this, they provide the XBindableValue interface which allows to set an external component to exchange the value with.</p> @@ -68,21 +68,21 @@ module com { module sun { module star { module form { module binding { <li><b>Activation</b><br/> An external value binding becomes effective as soon as it is set. This is a difference to SQL bindings, which only are effective when the parent form - of the control model is loaded (<type scope="com::sun::star::form">XLoadable</type>). + of the control model is loaded (com::sun::star::form::XLoadable). </li> <li><b>Immediacy</b><br/> When a BindableDataAwareControlModel is bound to an external value, then every change in the control model's value is <em>immediately</em> reflected in the external binding. This is a difference to SQL bindings of most - <type scope="com::sun::star::form">DataAwareControlModel</type>'s, where changes + com::sun::star::form::DataAwareControlModel's, where changes in the control model's value are only propagated to the bound column upon explicit request via <member scope="com::sun::star::form">XBoundComponent::commit</member>.<br/> Note that this restriction is inherited from the BindableControlModel. </li> <li><b>Cloning</b><br/> - <type scope="com::sun::star::form">FormControlModel</type>s support cloning themselves - via the <type scope="com::sun::star::util">XCloneable</type> interface which they - inherit from the <type scope="com::sun::star::awt">UnoControlModel</type> service.</br> + com::sun::star::form::FormControlModels support cloning themselves + via the com::sun::star::util::XCloneable interface which they + inherit from the com::sun::star::awt::UnoControlModel service.</br> When a BindableDataAwareControlModel is cloned while it has an active external value binding, then the clone is also bound to the same binding instance.<br/> Note that this restriction is inherited from the BindableControlModel. @@ -100,7 +100,7 @@ module com { module sun { module star { module form { module binding { service BindableDataAwareControlModel { /** specifies the functionality for binding the control model to a - column of an SQL <type scope="com::sun::star::form::component">DataForm</type>. + column of an SQL com::sun::star::form::component::DataForm. */ service com::sun::star::form::DataAwareControlModel; diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseCheckBox.idl b/offapi/com/sun/star/form/binding/BindableDatabaseCheckBox.idl index 0b628c9f5ae9..bcd637974b31 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseCheckBox.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseCheckBox.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module form { module binding { /** This service specifies a check box which is data-aware and thus can be bound to a database field, and additionally supports binding to arbitrary external values. - <p>The <type scope="com::sun::star::form::binding">XValueBinding</type> instance which + <p>The com::sun::star::form::binding::XValueBinding instance which can be associated with a BindableDatabaseCheckBox must support exchanging boolean values. The following mapping between external values and control states apply: <ul><li><TRUE/> will be mapped to the box being checked, and vice versa</li> diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseComboBox.idl b/offapi/com/sun/star/form/binding/BindableDatabaseComboBox.idl index 592ad5bcd8e6..b63d271e1260 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseComboBox.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseComboBox.idl @@ -31,7 +31,7 @@ module com { module sun { module star { module form { module binding { input field) which is data-aware and thus can be bound to a database field, and additionally supports binding to arbitrary external values. - <p>If an <type scope="com::sun::star::form::binding">ValueBinding</type> instance is + <p>If an com::sun::star::form::binding::ValueBinding instance is set at the field, it will exchange it's text with the binding as <em>string</em>, thus only bindings supporting string exchange will be accepted in <member scope="com::sun::star::form::binding">XValueBinding::setValueBinding</member>. diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseDateField.idl b/offapi/com/sun/star/form/binding/BindableDatabaseDateField.idl index b65814883593..c4c2c9f8aa43 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseDateField.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseDateField.idl @@ -30,8 +30,8 @@ module com { module sun { module star { module form { module binding { /** This service specifies a date input field which is data-aware and thus can be bound to a database field, and additionally supports binding to arbitrary external values. - <p>If an <type scope="com::sun::star::form::binding">ValueBinding</type> instance is - set at the field, it will exchange it's content with the binding as <type scope="com::sun::star::util">Date</type>. + <p>If an com::sun::star::form::binding::ValueBinding instance is + set at the field, it will exchange it's content with the binding as com::sun::star::util::Date. </p> @see com::sun::star::form::binding::XValueBinding::supportsType diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseFormattedField.idl b/offapi/com/sun/star/form/binding/BindableDatabaseFormattedField.idl index 37fedc23ac5d..b463892f3001 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseFormattedField.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseFormattedField.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module form { module binding { /** This service specifies a formatted input field which is data-aware and thus can be bound to a database field, and additionally supports binding to arbitrary external values. - <p>The <type scope="com::sun::star::form::binding">XValueBinding</type> instance which + <p>The com::sun::star::form::binding::XValueBinding instance which can be associated with a BindableDatabaseFormattedField must support exchanging values of type <em>double</em>.</p> diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseNumericField.idl b/offapi/com/sun/star/form/binding/BindableDatabaseNumericField.idl index 511acfb6e3fd..f8c0eb96fdb7 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseNumericField.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseNumericField.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module form { module binding { /** This service specifies a numeric input field which is data-aware and thus can be bound to a database field, and additionally supports binding to arbitrary external values. - <p>The <type scope="com::sun::star::form::binding">XValueBinding</type> instance which + <p>The com::sun::star::form::binding::XValueBinding instance which can be associated with a BindableDatabaseNumericField must support exchanging values of type <em>double</em>.</p> diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl b/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl index c7eb5fbb2b0c..81d86b04d0b9 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseRadioButton.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module form { module binding { /** This service specifies a radio button which is data-aware and thus can be bound to a database field, and additionally supports binding to arbitrary external values. - <p>The <type scope="com::sun::star::form::binding">XValueBinding</type> instance which + <p>The com::sun::star::form::binding::XValueBinding instance which can be associated with a BindableDatabaseRadioButton must support exchanging boolean values. The following mapping between external values and control states apply: <ul><li><TRUE/> will be mapped to the button being checked, and vice versa</li> diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseTextField.idl b/offapi/com/sun/star/form/binding/BindableDatabaseTextField.idl index 41f382aa737e..7cf7135ce574 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseTextField.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseTextField.idl @@ -30,7 +30,7 @@ module com { module sun { module star { module form { module binding { /** This service specifies a text input field which is data-aware and thus can be bound to a database field, and additionally supports binding to arbitrary external values. - <p>If an <type scope="com::sun::star::form::binding">ValueBinding</type> instance is + <p>If an com::sun::star::form::binding::ValueBinding instance is set at the field, it will exchange it's text with the binding as <em>string</em>, thus only bindings supporting string exchange will be accepted in <member scope="com::sun::star::form::binding">XValueBinding::setValueBinding</member>. diff --git a/offapi/com/sun/star/form/binding/BindableDatabaseTimeField.idl b/offapi/com/sun/star/form/binding/BindableDatabaseTimeField.idl index 1d0d7c3c47bc..fb199ab1f427 100644 --- a/offapi/com/sun/star/form/binding/BindableDatabaseTimeField.idl +++ b/offapi/com/sun/star/form/binding/BindableDatabaseTimeField.idl @@ -30,8 +30,8 @@ module com { module sun { module star { module form { module binding { /** This service specifies a date input field which is data-aware and thus can be bound to a database field, and additionally supports binding to arbitrary external values. - <p>If an <type scope="com::sun::star::form::binding">ValueBinding</type> instance is - set at the field, it will exchange it's content with the binding as <type scope="com::sun::star::util">Time</type>. + <p>If an com::sun::star::form::binding::ValueBinding instance is + set at the field, it will exchange it's content with the binding as com::sun::star::util::Time. </p> @see com::sun::star::form::binding::XValueBinding::supportsType diff --git a/offapi/com/sun/star/form/binding/XListEntrySource.idl b/offapi/com/sun/star/form/binding/XListEntrySource.idl index db1f0efcbf30..5d51089d574f 100644 --- a/offapi/com/sun/star/form/binding/XListEntrySource.idl +++ b/offapi/com/sun/star/form/binding/XListEntrySource.idl @@ -45,7 +45,7 @@ interface XListEntrySource : com::sun::star::uno::XInterface /** provides access to a single list entry - @throws <type scope="com::sun::star::lang">IndexOutOfBoundsException</type> + @throws com::sun::star::lang::IndexOutOfBoundsException if the given position does not denote a valid index in the list @see getListEntryCount @@ -61,7 +61,7 @@ interface XListEntrySource : com::sun::star::uno::XInterface /** adds a listener which will be notified about changes in the list reflected by the component. - @throws <type scope="com::sun::star::lang">NullPointerException</type> + @throws com::sun::star::lang::NullPointerException if the given listener is <NULL/> */ void addListEntryListener( [in] XListEntryListener Listener ) @@ -70,7 +70,7 @@ interface XListEntrySource : com::sun::star::uno::XInterface /** revokes the given listener from the list of components which will be notified about changes in the entry list. - @throws <type scope="com::sun::star::lang">NullPointerException</type> + @throws com::sun::star::lang::NullPointerException if the given listener is <NULL/> */ void removeListEntryListener( [in] XListEntryListener Listener ) diff --git a/offapi/com/sun/star/form/binding/XValueBinding.idl b/offapi/com/sun/star/form/binding/XValueBinding.idl index 68400f583156..83e9689e3afa 100644 --- a/offapi/com/sun/star/form/binding/XValueBinding.idl +++ b/offapi/com/sun/star/form/binding/XValueBinding.idl @@ -67,7 +67,7 @@ interface XValueBinding : com::sun::star::uno::XInterface if the value currently cannot be changed, since the binding is not fully operational. Possible reasons for this include the binding being readonly, or the target of the binding not being present. - @throws <type scope="com::sun::star::lang">NoSupportException</type> + @throws com::sun::star::lang::NoSupportException if the binding in general does not support write access to it's binding @see getSupportedValueTypes diff --git a/offapi/com/sun/star/form/component/CommandButton.idl b/offapi/com/sun/star/form/component/CommandButton.idl index 0913803cb2dc..d5eeb7441acb 100644 --- a/offapi/com/sun/star/form/component/CommandButton.idl +++ b/offapi/com/sun/star/form/component/CommandButton.idl @@ -63,7 +63,7 @@ published service CommandButton <p>This property is evaluated if the button is of type URL.</p> <p>As always, there is a number of target names which have a special meaning, and force - a special <type scope="com::sun::star::frame">Frame</type> to be used.</p> + a special com::sun::star::frame::Frame to be used.</p> */ [property] string TargetFrame; @@ -82,7 +82,7 @@ published service CommandButton be reset.</p> <p>For a given implementation of the interface, if this (optional) property is present, then also the optional - interface <type scope="com::sun::star::form">XReset</type> must be present.</p> + interface com::sun::star::form::XReset must be present.</p> */ [optional, property] boolean DefaultState; diff --git a/offapi/com/sun/star/form/component/DataForm.idl b/offapi/com/sun/star/form/component/DataForm.idl index 477af290900f..db48537521b9 100644 --- a/offapi/com/sun/star/form/component/DataForm.idl +++ b/offapi/com/sun/star/form/component/DataForm.idl @@ -56,12 +56,12 @@ published service DataForm <p>The insertion row is a virtual row which is used to insert new records. It is reached by calling <member scope="com::sun::star::sdbc">XResultSetUpdate::moveToInsertRow</member>. - The <type scope="com::sun::star::sdb">RowSet</type> service specifies exactly which notifications + The com::sun::star::sdb::RowSet service specifies exactly which notifications happen in which order when calling <member scope="com::sun::star::sdbc">XResultSetUpdate::moveToInsertRow</member>, and a DataForm implementation extends this with the following contract: - <ul><li>After all notifications as defined in the <type scope="com::sun::star::sdb">RowSet</type> + <ul><li>After all notifications as defined in the com::sun::star::sdb::RowSet service have been sent, the DataForm resets itself, if all - <type scope="com::sun::star::form">XResetListeners</type> approve this.</li> + com::sun::star::form::XResetListeners approve this.</li> <li>After the reset happened, the <member scope="com::sun::star::sdb">RowSet::IsModified</member> property is reset to <FALSE/>. This property might have been switched to <TRUE/> during listener notifications, since listeners are allowed to change field values. Also, the @@ -97,7 +97,7 @@ published service DataForm /** can be used for filling parameters. <p>You can add your component as - <type scope="com::sun::star::form">XDatabaseParameterListener</type> + com::sun::star::form::XDatabaseParameterListener to a form to get notified whenever the form needs parameter values to be filled in<br/> In a first approach, the form tries to fill any parameters from it's master-detail relation (if any). All values which can't be filled are then passed to all listeners, which can diff --git a/offapi/com/sun/star/form/component/DatabaseImageControl.idl b/offapi/com/sun/star/form/component/DatabaseImageControl.idl index b6e102c913e0..02984b1f6eef 100644 --- a/offapi/com/sun/star/form/component/DatabaseImageControl.idl +++ b/offapi/com/sun/star/form/component/DatabaseImageControl.idl @@ -32,7 +32,7 @@ /** specifies the model of a control used for displaying images stored in a database. - <p>As every <type scope="com::sun::star::form">DataAwareControlModel</type>, an image control + <p>As every com::sun::star::form::DataAwareControlModel, an image control can be bound to a database field. This means that for instance with every record change, the content of the database field is taken, interpreted as image, and displayed in the control.<br/> Unlike other more text-based controls, it does not interpret the content of the field as text or double, @@ -54,10 +54,10 @@ <p>In a usual data form, the scenario will be as follows: <ul><li>There is a DatabaseImageControl as part of the document model, which acts as - control model for an <type scope="com::sun::star::form::control">ImageControl</type>.</li> + control model for an com::sun::star::form::control::ImageControl.</li> - <li>The control is an <type scope="com::sun::star::awt">XImageConsumer</type> for the - <type scope="com::sun::star::awt">XImageProducer</type> supplied by the model.</li> + <li>The control is an com::sun::star::awt::XImageConsumer for the + com::sun::star::awt::XImageProducer supplied by the model.</li> <li>Whenever the form's cursor is positioned on a new record, the column the control model is bound to is examined for a binary data stream. This stream is set as source @@ -84,9 +84,9 @@ published service DatabaseImageControl service com::sun::star::form::DataAwareControlModel; - /** supplies the caller with an <type scope="com::sun::star::awt">XImageProducer</type>. + /** supplies the caller with an com::sun::star::awt::XImageProducer. - <p>Other components can register as <type scope="com::sun::star::awt">XImageConsumer</type> + <p>Other components can register as com::sun::star::awt::XImageConsumer at this producer. Then they will be notified of any change in the image to be displayed.</p> */ interface com::sun::star::form::XImageProducerSupplier; diff --git a/offapi/com/sun/star/form/component/DatabaseListBox.idl b/offapi/com/sun/star/form/component/DatabaseListBox.idl index ba078d84150f..54df8a5ef802 100644 --- a/offapi/com/sun/star/form/component/DatabaseListBox.idl +++ b/offapi/com/sun/star/form/component/DatabaseListBox.idl @@ -118,7 +118,7 @@ published service DatabaseListBox determines the query which the list result set should be based on.<br/> For retrieving the query, the connection which the data form is working with (<member scope="com::sun::star::sdb">RowSet::ActiveConnection</member>) is queried for - the <type scope="com::sun::star::sdb">XQueriesSupplier</type> interface.</dd> + the com::sun::star::sdb::XQueriesSupplier interface.</dd> <dt><member scope="com::sun::star::form">ListSourceType::SQL</member></dt> <dd>The first element of the string sequence in <member>ListBox::ListSource</member> diff --git a/offapi/com/sun/star/form/component/GridControl.idl b/offapi/com/sun/star/form/component/GridControl.idl index 5f9c8a3aaea5..11bcb2e75e56 100644 --- a/offapi/com/sun/star/form/component/GridControl.idl +++ b/offapi/com/sun/star/form/component/GridControl.idl @@ -57,19 +57,19 @@ the control belongs to, and the columns correspond to single columns of the form's row set.</p> <p>Columns of a grid control are modeled by own objects, too. They are very similar to usual - <type scope="com::sun::star::form">DataAwareControlModel</type>s modeling other "single-value" controls, but they are not described - as own services. Instead, they need to be created using the <type scope="com::sun::star::form">XGridColumnFactory</type> interface.</p> + com::sun::star::form::DataAwareControlModels modeling other "single-value" controls, but they are not described + as own services. Instead, they need to be created using the com::sun::star::form::XGridColumnFactory interface.</p> */ published service GridControl { service com::sun::star::form::FormControlModel; - /** provides basic functionality of a container of <type scope="com::sun::star::form">FormComponent</type>s. + /** provides basic functionality of a container of com::sun::star::form::FormComponents. <p>All the container-related methods of this service related to control models, this is what are the container elements for a GridControl.</p> - <p>As the <type scope="com::sun::star::form">FormComponents</type> service also specifies + <p>As the com::sun::star::form::FormComponents service also specifies the <type scope"com::sun::star::script">XEventAttacherManager</type> service, grid control models also provide a scripting environment for their columns.</p> */ diff --git a/offapi/com/sun/star/form/component/HiddenControl.idl b/offapi/com/sun/star/form/component/HiddenControl.idl index 16d24f00a325..3994b54e4706 100644 --- a/offapi/com/sun/star/form/component/HiddenControl.idl +++ b/offapi/com/sun/star/form/component/HiddenControl.idl @@ -31,7 +31,7 @@ <p>The only sense of a hidden control is to store data in the form which is not visible to the user.</p> - <p>Usually, hidden controls are used in <type scope="com::sun::star::form::component">HTMLForm</type>s, + <p>Usually, hidden controls are used in com::sun::star::form::component::HTMLForms, where they contain data which is to be submitted.<br/> Nevertheless, you can use them in your own forms for storing any data, for instance to evaluate it in some scripting macro.</p> diff --git a/offapi/com/sun/star/form/component/ImageButton.idl b/offapi/com/sun/star/form/component/ImageButton.idl index ee804b18e34d..b32f4ea9eccc 100644 --- a/offapi/com/sun/star/form/component/ImageButton.idl +++ b/offapi/com/sun/star/form/component/ImageButton.idl @@ -49,15 +49,15 @@ published service ImageButton service com::sun::star::form::FormControlModel; - /** supplies the caller with an <type scope="com::sun::star::awt">XImageProducer</type>. + /** supplies the caller with an com::sun::star::awt::XImageProducer. - <p>Other components can register as <type scope="com::sun::star::awt">XImageConsumer</type> + <p>Other components can register as com::sun::star::awt::XImageConsumer at this producer. Then they will be notified of any change in the image to be displayed.</p> <p>Whenever the <member scope="com::sun::star::awt">UnoControlImageControlModel::ImageURL</member> property is changed, the model loads the specified image, and sets it as image source - at its <type scope="com::sun::star::awt">XImageProducer</type>. Then, all - <type scope="com::sun::star::awt">XImageConsumer</type>s are notified and supplied with + at its com::sun::star::awt::XImageProducer. Then, all + com::sun::star::awt::XImageConsumers are notified and supplied with the binary data of the image.<br/> Usually, controls acting for an ImageButton model are consumers, and use the data stream to display the image</p> @@ -73,7 +73,7 @@ published service ImageButton <p>This property is evaluated if the button is of type URL.</p> <p>As always, there is a number of target names which have a special meaning, and force - a special <type scope="com::sun::star::frame">Frame</type> to be used.</p> + a special com::sun::star::frame::Frame to be used.</p> */ [property] string TargetFrame; diff --git a/offapi/com/sun/star/form/component/NavigationToolBar.idl b/offapi/com/sun/star/form/component/NavigationToolBar.idl index 275f17627103..a63e954d3bcf 100644 --- a/offapi/com/sun/star/form/component/NavigationToolBar.idl +++ b/offapi/com/sun/star/form/component/NavigationToolBar.idl @@ -65,14 +65,14 @@ service NavigationToolBar /** specifies the relief for the font described in <member>FontDescriptor</member> - <p>The value must be one of the <type scope="com::sun::star::text">FontRelief</type> + <p>The value must be one of the com::sun::star::text::FontRelief constants.</p> */ [property] long FontRelief; /** specifies the emphasis mark for the font described in <member>FontDescriptor</member> - <p>The value must be one of the <type scope="com::sun::star::text">FontEmphasis</type> + <p>The value must be one of the com::sun::star::text::FontEmphasis constants.</p> */ [property] long FontEmphasisMark; diff --git a/offapi/com/sun/star/form/component/RadioButton.idl b/offapi/com/sun/star/form/component/RadioButton.idl index 25017b23e0ba..aa96b251c380 100644 --- a/offapi/com/sun/star/form/component/RadioButton.idl +++ b/offapi/com/sun/star/form/component/RadioButton.idl @@ -70,7 +70,7 @@ published service RadioButton form. <p>If the form the control belongs to is to be submitted (see - <type scope="com::sun::star::form">XSubmit</type>), and the control is checked, this reference + com::sun::star::form::XSubmit), and the control is checked, this reference value is used for submission.</p> */ [property] string RefValue; diff --git a/offapi/com/sun/star/form/component/RichTextControl.idl b/offapi/com/sun/star/form/component/RichTextControl.idl index be385a191a34..c8ca99185998 100644 --- a/offapi/com/sun/star/form/component/RichTextControl.idl +++ b/offapi/com/sun/star/form/component/RichTextControl.idl @@ -28,7 +28,7 @@ module com { module sun { module star { module form { module component { -/** specifies a component which extends the <type scope="com::sun::star::awt">UnoControlEditModel</type> +/** specifies a component which extends the com::sun::star::awt::UnoControlEditModel with capabilities to display and input formatted text. */ published service RichTextControl @@ -38,7 +38,7 @@ published service RichTextControl service com::sun::star::form::FormControlModel; /** specifies capabilities to provide rich text, as opposed to the simple text provided by the - <type scope="com::sun::star::awt">UnoControlEditModel</type> + com::sun::star::awt::UnoControlEditModel */ service com::sun::star::text::TextRange; @@ -52,7 +52,7 @@ published service RichTextControl /** specifies whether the control should display the text including all its formatting. <p>If this is set to <FALSE/>, the control will act as ordinary - <type scope="com::sun::star::awt">UnoControlEditModel</type>.</p> + com::sun::star::awt::UnoControlEditModel.</p> <p>If the property is set to <TRUE/>, the control will ignore the following properties: <ul> diff --git a/offapi/com/sun/star/form/component/SubmitButton.idl b/offapi/com/sun/star/form/component/SubmitButton.idl index eed9c7bcd5ed..3a0cf89b1e6f 100644 --- a/offapi/com/sun/star/form/component/SubmitButton.idl +++ b/offapi/com/sun/star/form/component/SubmitButton.idl @@ -40,7 +40,7 @@ service SubmitButton <p>Note that the control model itself will not make any use of the submission. Instead, submissions are triggered by a control (not a control <em>model</em>). - Thus, the <type scope="com::sun::star::form::control">SubmitButton</type> + Thus, the com::sun::star::form::control::SubmitButton control associated with a SubmitButton model is responsible for using the submission supplied at this model.</p> */ diff --git a/offapi/com/sun/star/form/control/CheckBox.idl b/offapi/com/sun/star/form/control/CheckBox.idl index 24aa1d39c769..e745c8acbd60 100644 --- a/offapi/com/sun/star/form/control/CheckBox.idl +++ b/offapi/com/sun/star/form/control/CheckBox.idl @@ -29,7 +29,7 @@ /** describes a check box control which can (but not necessarily has to) be bound to a database field. - <p>The model of the control has to support the <type scope="com::sun::star::form::component">CheckBox</type> + <p>The model of the control has to support the com::sun::star::form::component::CheckBox service.</p> @see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/ComboBox.idl b/offapi/com/sun/star/form/control/ComboBox.idl index 68ca2dd2099c..91a7b9e4d1a2 100644 --- a/offapi/com/sun/star/form/control/ComboBox.idl +++ b/offapi/com/sun/star/form/control/ComboBox.idl @@ -29,7 +29,7 @@ /** describes a combo box control. - <p>The model of the control has to support the <type scope="com::sun::star::form::component">ComboBox</type> + <p>The model of the control has to support the com::sun::star::form::component::ComboBox service.</p> @see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/CommandButton.idl b/offapi/com/sun/star/form/control/CommandButton.idl index d826536e903c..84c646b1f6cb 100644 --- a/offapi/com/sun/star/form/control/CommandButton.idl +++ b/offapi/com/sun/star/form/control/CommandButton.idl @@ -29,7 +29,7 @@ /** describes a button control. - <p>The model of the control has to support the <type scope="com::sun::star::form::component">CommandButton</type> + <p>The model of the control has to support the com::sun::star::form::component::CommandButton service.</p> <p>The control is clickable, the action taken upon clicking depends on the settings @@ -45,10 +45,10 @@ published service CommandButton /** allows external instances to register as veto listener for the button's actions. - <p>An <type scope="com::sun::star::form">XApproveActionListener</type> returning false on + <p>An com::sun::star::form::XApproveActionListener returning false on it's approve-method will prevent any action which would usually be triggered - this includes not only submitting or resetting forms, but also calling the - <type scope="com::sun::star::awt">XActionListener</type>s of the super service<br/> + com::sun::star::awt::XActionListeners of the super service<br/> This may be interesting for e.g. forms which want to provide input validation before submitting data.<br/> diff --git a/offapi/com/sun/star/form/control/CurrencyField.idl b/offapi/com/sun/star/form/control/CurrencyField.idl index 8e3070e8f853..6a44c7e47a28 100644 --- a/offapi/com/sun/star/form/control/CurrencyField.idl +++ b/offapi/com/sun/star/form/control/CurrencyField.idl @@ -30,7 +30,7 @@ /** describes a control which can be used for inputting currency values, and which can (but not necessarily has to) be bound to a database field. - <p>The model of the control has to support the <type scope="com::sun::star::form::component">CurrencyField</type> + <p>The model of the control has to support the com::sun::star::form::component::CurrencyField service.</p> @see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/DateField.idl b/offapi/com/sun/star/form/control/DateField.idl index 0c4622be1a70..90ced2c586e5 100644 --- a/offapi/com/sun/star/form/control/DateField.idl +++ b/offapi/com/sun/star/form/control/DateField.idl @@ -30,7 +30,7 @@ /** describes a control which can be used for inputting date values, and which can (but not necessarily has to) be bound to a database field. - <p>The model of the control has to support the <type scope="com::sun::star::form::component">DateField</type> + <p>The model of the control has to support the com::sun::star::form::component::DateField service.</p> @see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/FilterControl.idl b/offapi/com/sun/star/form/control/FilterControl.idl index c2b32dcefe9c..e42a05c2e454 100644 --- a/offapi/com/sun/star/form/control/FilterControl.idl +++ b/offapi/com/sun/star/form/control/FilterControl.idl @@ -31,7 +31,7 @@ /** describes a check box control which can (but not necessarily has to) be bound to a database field. - <p>The model of the control has to support the <type scope="com::sun::star::form::component">CheckBox</type> + <p>The model of the control has to support the com::sun::star::form::component::CheckBox service.</p> @see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/FormattedField.idl b/offapi/com/sun/star/form/control/FormattedField.idl index ecc620fbd001..dd5922cfb0e1 100644 --- a/offapi/com/sun/star/form/control/FormattedField.idl +++ b/offapi/com/sun/star/form/control/FormattedField.idl @@ -30,7 +30,7 @@ /** describes a control which can be used for inputting values with a arbitrary formatting, and can (but not necessarily has to) be bound to a database field. - <p>The model of the control has to support the <type scope="com::sun::star::form::component">FormattedField</type> + <p>The model of the control has to support the com::sun::star::form::component::FormattedField service.</p> <p>In addition, this control can be used in HTML forms. It triggers the diff --git a/offapi/com/sun/star/form/control/GridControl.idl b/offapi/com/sun/star/form/control/GridControl.idl index 34beb558b29f..0e6332296bd8 100644 --- a/offapi/com/sun/star/form/control/GridControl.idl +++ b/offapi/com/sun/star/form/control/GridControl.idl @@ -42,7 +42,7 @@ module control { /** describes a table-like control for displaying data. - <p>The model of the control has to support the <type scope="com::sun::star::form::component">GridControl</type> + <p>The model of the control has to support the com::sun::star::form::component::GridControl service.</p> @see com::sun::star::awt::UnoControl @@ -92,7 +92,7 @@ published service GridControl <p>The selection used with the methods <method scope="com::sun::star::view">XSelectionSupplier::getSelection</method> and <method scope="com::sun::star::view">XSelectionSupplier::select</method> is a sequence of Any's.<br/> - Here the elements of the Sequence are the bookmarks (in the <type scope="com::sun::star::sdb">RowSet</type>) + Here the elements of the Sequence are the bookmarks (in the com::sun::star::sdb::RowSet) of the (to-be-) selected rows.</p> */ [optional] interface com::sun::star::view::XSelectionSupplier; diff --git a/offapi/com/sun/star/form/control/GroupBox.idl b/offapi/com/sun/star/form/control/GroupBox.idl index ada0b9f98ceb..b99e935369d6 100644 --- a/offapi/com/sun/star/form/control/GroupBox.idl +++ b/offapi/com/sun/star/form/control/GroupBox.idl @@ -29,7 +29,7 @@ /** describes a control which can be used for visually grouping controls - <p>The model of the control has to support the <type scope="com::sun::star::form::component">GroupBox</type> + <p>The model of the control has to support the com::sun::star::form::component::GroupBox service.</p> @see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/ImageButton.idl b/offapi/com/sun/star/form/control/ImageButton.idl index a434200db372..787ec26176ca 100644 --- a/offapi/com/sun/star/form/control/ImageButton.idl +++ b/offapi/com/sun/star/form/control/ImageButton.idl @@ -29,7 +29,7 @@ /** describes a control which can be used for displaying images on a control acting like a button. - <p>The model of the control has to support the <type scope="com::sun::star::form::component">ImageButton</type> + <p>The model of the control has to support the com::sun::star::form::component::ImageButton service.</p> <p>The control is clickable, the action taken upon clicking depends on the settings @@ -45,10 +45,10 @@ published service ImageButton /** allows external instances to register as veto listener for the button's actions. - <p>An <type scope="com::sun::star::form">XApproveActionListener</type> returning false on + <p>An com::sun::star::form::XApproveActionListener returning false on it's approve-method will prevent any action which would usually be triggered - this includes not only submitting or resetting forms, but also calling the - <type scope="com::sun::star::awt">XActionListener</type>s of the super service<br/> + com::sun::star::awt::XActionListeners of the super service<br/> This may be interesting for e.g. forms which want to provide input validation before submitting data.<br/> diff --git a/offapi/com/sun/star/form/control/ImageControl.idl b/offapi/com/sun/star/form/control/ImageControl.idl index 58700d3ab330..9c2f5f5191b4 100644 --- a/offapi/com/sun/star/form/control/ImageControl.idl +++ b/offapi/com/sun/star/form/control/ImageControl.idl @@ -29,7 +29,7 @@ /** describes a control used for displaying images stored in a database. - <p>The model of the control has to support the <type scope="com::sun::star::form::component">DatabaseImageControl</type> + <p>The model of the control has to support the com::sun::star::form::component::DatabaseImageControl service.</p> <p>If the model of the control is valid bound to a database field, the control allows diff --git a/offapi/com/sun/star/form/control/ListBox.idl b/offapi/com/sun/star/form/control/ListBox.idl index 5f15d29f993e..db1c96ad1b1e 100644 --- a/offapi/com/sun/star/form/control/ListBox.idl +++ b/offapi/com/sun/star/form/control/ListBox.idl @@ -30,7 +30,7 @@ /** describes a list box control which can (but not necessarily has to) be bound to a database field. - <p>The model of the control has to support the <type scope="com::sun::star::form::component">ListBox</type> + <p>The model of the control has to support the com::sun::star::form::component::ListBox service.</p> @see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/NavigationToolBar.idl b/offapi/com/sun/star/form/control/NavigationToolBar.idl index 9c8621cc646c..3b5562749de1 100644 --- a/offapi/com/sun/star/form/control/NavigationToolBar.idl +++ b/offapi/com/sun/star/form/control/NavigationToolBar.idl @@ -27,7 +27,7 @@ module com { module sun { module star { module form { module control { /** This service specifies the model for control which provides controller - functionality for a <type scope="com::sun::star::form::component">DataForm</type>, such as navigating or filtering + functionality for a com::sun::star::form::component::DataForm, such as navigating or filtering the form. @see com::sun::star::form::component::NavigationToolBar diff --git a/offapi/com/sun/star/form/control/NumericField.idl b/offapi/com/sun/star/form/control/NumericField.idl index 3fab3e24f62a..1b1114bfc86d 100644 --- a/offapi/com/sun/star/form/control/NumericField.idl +++ b/offapi/com/sun/star/form/control/NumericField.idl @@ -30,7 +30,7 @@ /** describes a control for inputting numeric values and which can (but not necessarily has to) be bound to a database field. - <p>The model of the control has to support the <type scope="com::sun::star::form::component">NumericField</type> + <p>The model of the control has to support the com::sun::star::form::component::NumericField service.</p> @see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/PatternField.idl b/offapi/com/sun/star/form/control/PatternField.idl index 1dba4f96109a..1492362e628b 100644 --- a/offapi/com/sun/star/form/control/PatternField.idl +++ b/offapi/com/sun/star/form/control/PatternField.idl @@ -30,7 +30,7 @@ /** describes a control for inputting text complying to a given pattern, and which can (but not necessarily has to) be bound to a database field. - <p>The model of the control has to support the <type scope="com::sun::star::form::component">PatternField</type> + <p>The model of the control has to support the com::sun::star::form::component::PatternField service.</p> @see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/RadioButton.idl b/offapi/com/sun/star/form/control/RadioButton.idl index b0af91cd9e97..33409ecec434 100644 --- a/offapi/com/sun/star/form/control/RadioButton.idl +++ b/offapi/com/sun/star/form/control/RadioButton.idl @@ -29,7 +29,7 @@ /** describes a radio button control which can (but not necessarily has to) be bound to a database field. - <p>The model of the control has to support the <type scope="com::sun::star::form::component">RadioButton</type> + <p>The model of the control has to support the com::sun::star::form::component::RadioButton service.</p> @see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/control/SubmitButton.idl b/offapi/com/sun/star/form/control/SubmitButton.idl index d9157b4a490f..7f3c9a1f6bcf 100644 --- a/offapi/com/sun/star/form/control/SubmitButton.idl +++ b/offapi/com/sun/star/form/control/SubmitButton.idl @@ -29,12 +29,12 @@ module com { module sun { module star { module form { module control { /** specifies a button control which can execute external submissions - <p>The model of the control has to support the <type scope="com::sun::star::form::component">SubmitButton</type> + <p>The model of the control has to support the com::sun::star::form::component::SubmitButton service.</p> <p>The control is clickable. When clicked (by mouse or keyboard, or programmatically), the following happens: - <ol><li>Any <type scope="com::sun::star::form::submission">XSubmissionVetoListener</type>s registered + <ol><li>Any com::sun::star::form::submission::XSubmissionVetoListeners registered at the component are given the chance to veto the submission. </li> <li>The model of the control is examined for an external submission object. That is, @@ -44,11 +44,11 @@ module com { module sun { module star { module form { module control { <member scope="com::sun::star::form::submission">XSubmission::submit</member> method is invoked. </li> <li>If there is no external submission, the parent object of the model is examined - for the presence of the <type scope="com::sun::star::form">XSubmit</type> interface. If it + for the presence of the com::sun::star::form::XSubmit interface. If it is present, it's <member scope="com::sun::star::form">XSubmit::submit</member> method is invoked.<br/> - Since the parent object of a submit button can only be a <type scope="com::sun::star::form::component">Form</type>, - this means that SubmitButtons are also able to submit <type scope="com::sun::star::form::component">HTMLForm</type>s. + 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. </li> </ol> </p> diff --git a/offapi/com/sun/star/form/control/TextField.idl b/offapi/com/sun/star/form/control/TextField.idl index bccd671cbf69..0d795ca5f828 100644 --- a/offapi/com/sun/star/form/control/TextField.idl +++ b/offapi/com/sun/star/form/control/TextField.idl @@ -31,7 +31,7 @@ /** describes a control for entering arbitrary text which can (but not necessarily has to) be bound to a database field. - <p>The model of the control has to support the <type scope="com::sun::star::form::component">TextField</type> + <p>The model of the control has to support the com::sun::star::form::component::TextField service.</p> <p>In addition, this control can be used in HTML forms. It triggers the diff --git a/offapi/com/sun/star/form/control/TimeField.idl b/offapi/com/sun/star/form/control/TimeField.idl index d8f567616859..aede8244f96e 100644 --- a/offapi/com/sun/star/form/control/TimeField.idl +++ b/offapi/com/sun/star/form/control/TimeField.idl @@ -30,7 +30,7 @@ /** describes a control for inputting time values which can (but not necessarily has to) be bound to a database field. - <p>The model of the control has to support the <type scope="com::sun::star::form::component">TimeField</type> + <p>The model of the control has to support the com::sun::star::form::component::TimeField service.</p> @see com::sun::star::awt::UnoControl diff --git a/offapi/com/sun/star/form/inspection/ButtonNavigationHandler.idl b/offapi/com/sun/star/form/inspection/ButtonNavigationHandler.idl index e66018bdae71..6870d53159b2 100644 --- a/offapi/com/sun/star/form/inspection/ButtonNavigationHandler.idl +++ b/offapi/com/sun/star/form/inspection/ButtonNavigationHandler.idl @@ -26,14 +26,14 @@ module com { module sun { module star { module form { module inspection { -/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type> +/** implements a property handler for use with an com::sun::star::inspection::ObjectInspector which is able to enhance the <member scope="com::sun::star::form::component">CommandButton::ButtonType</member> and <member scope="com::sun::star::form::component">CommandButton::TargetURL</member> properties of a - <type scope="com::sun::star::form::component">CommandButton</type>. + com::sun::star::form::component::CommandButton. <p>For this, the two properties are superseded by new versions, where as button type, additional possible values are added for navigating the parent form of the button. For instance, in an - <type scope="com::sun::star::inspection">ObjectInspector</type> using this handler, the user will be able + com::sun::star::inspection::ObjectInspector using this handler, the user will be able to choose a button type saying "move to the next record", which, when chosen, well, moves the parent database form of the button to the next record.</p> diff --git a/offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl b/offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl index 1d82d7a80fe7..9893a6c54f14 100644 --- a/offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl +++ b/offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl @@ -26,14 +26,14 @@ module com { module sun { module star { module form { module inspection { -/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type> +/** implements a property handler for use with an com::sun::star::inspection::ObjectInspector which is able to provide properties to bind a form component to a spreadsheet cell. <p>The handler expects a value named "ContextDocument" in the context in which it is created. - That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the + That is, the com::sun::star::uno::XComponentContext used for creating the CellBindingPropertyHandler is examined for a value with this name. If the object in this - value denotes a spreadsheet document (indicated by supporting the <type scope="com::sun::star::sheet">XSpreadsheetDocument</type> - interface), this document is used to create the <type scope="com::sun::star::form::binding">ValueBinding</type>s + value denotes a spreadsheet document (indicated by supporting the com::sun::star::sheet::XSpreadsheetDocument + interface), this document is used to create the com::sun::star::form::binding::ValueBindings to bind the inspected object to cells in this document.</p> @see com::sun::star::inspection::XPropertyHandler diff --git a/offapi/com/sun/star/form/inspection/DefaultFormComponentInspectorModel.idl b/offapi/com/sun/star/form/inspection/DefaultFormComponentInspectorModel.idl index 63e785427454..72085c20fefb 100644 --- a/offapi/com/sun/star/form/inspection/DefaultFormComponentInspectorModel.idl +++ b/offapi/com/sun/star/form/inspection/DefaultFormComponentInspectorModel.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module form { module inspection { -/** implements a <type scope="com::sun::star::inspection">XObjectInspectorModel</type> for +/** implements a com::sun::star::inspection::XObjectInspectorModel for inspecting form components, in particular all components implementing the FormComponent service. diff --git a/offapi/com/sun/star/form/inspection/EditPropertyHandler.idl b/offapi/com/sun/star/form/inspection/EditPropertyHandler.idl index 23d1fdf0e85e..4ee856d3b1db 100644 --- a/offapi/com/sun/star/form/inspection/EditPropertyHandler.idl +++ b/offapi/com/sun/star/form/inspection/EditPropertyHandler.idl @@ -26,15 +26,15 @@ module com { module sun { module star { module form { module inspection { -/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type> +/** implements a property handler for use with an com::sun::star::inspection::ObjectInspector which provides convenience wrappers for some properties existing at a form component - derived from <type scope="com::sun::star::awt">UnoControlEditModel</type>. + derived from com::sun::star::awt::UnoControlEditModel. - <p>First, the handler supersedes the HScroll and the VScroll properties of a <type scope="com::sun::star::awt">UnoControlEditModel</type> + <p>First, the handler supersedes the HScroll and the VScroll properties of a com::sun::star::awt::UnoControlEditModel and puts them into one common property, allowing the user to choose whether she want to have "no", a "vertical", a "horizontal", or "both" scrollbars.<p> - <p>Second, if it detects a <type scope="com::sun::star::form::component">RichTextControl</type> to inspect, + <p>Second, if it detects a com::sun::star::form::component::RichTextControl to inspect, it supersedes the <member scope="com::sun::star::form::component">RichTextControl::RichText</member> and the <member scope="com::sun::star::awt">UnoControlEditModel::MultiLine</member> properties with a new one which allows choosing the text type with one single action.</p> diff --git a/offapi/com/sun/star/form/inspection/EventHandler.idl b/offapi/com/sun/star/form/inspection/EventHandler.idl index 1f40182c00ca..cf5d8dcdbf37 100644 --- a/offapi/com/sun/star/form/inspection/EventHandler.idl +++ b/offapi/com/sun/star/form/inspection/EventHandler.idl @@ -26,12 +26,12 @@ module com { module sun { module star { module form { module inspection { -/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type> - which, for a <type scope="com::sun::star::form">FormComponent</type>, provides the script events +/** implements a property handler for use with an com::sun::star::inspection::ObjectInspector + which, for a com::sun::star::form::FormComponent, provides the script events offered by this form component. - <p>For this, the parent of the form component, which by definition supports the <type scope="com::sun::star::form">FormComponent</type> - service, is examined for the <type scope="com::sun::star::script">XEventAttacherManager</type> interface.</p> + <p>For this, the parent of the form component, which by definition supports the com::sun::star::form::FormComponent + service, is examined for the com::sun::star::script::XEventAttacherManager interface.</p> @see com::sun::star::inspection::XPropertyHandler @see com::sun::star::form::component::CommandButton diff --git a/offapi/com/sun/star/form/inspection/FormComponentPropertyHandler.idl b/offapi/com/sun/star/form/inspection/FormComponentPropertyHandler.idl index 7c1a366d44f3..4fbe59dfb9f9 100644 --- a/offapi/com/sun/star/form/inspection/FormComponentPropertyHandler.idl +++ b/offapi/com/sun/star/form/inspection/FormComponentPropertyHandler.idl @@ -26,7 +26,7 @@ module com { module sun { module star { module form { module inspection { -/** implements the default property handler for all known types of <type scope="com::sun::star::form">FormComponent</type>s. +/** implements the default property handler for all known types of com::sun::star::form::FormComponents. @see com::sun::star::inspection::XPropertyHandler @see com::sun::star::form::FormComponents diff --git a/offapi/com/sun/star/form/inspection/SubmissionPropertyHandler.idl b/offapi/com/sun/star/form/inspection/SubmissionPropertyHandler.idl index d27640bd9c76..0eb65962ae26 100644 --- a/offapi/com/sun/star/form/inspection/SubmissionPropertyHandler.idl +++ b/offapi/com/sun/star/form/inspection/SubmissionPropertyHandler.idl @@ -26,13 +26,13 @@ module com { module sun { module star { module form { module inspection { -/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type> +/** implements a property handler for use with an com::sun::star::inspection::ObjectInspector which provides properties for button controls which support submission of XML forms. <p>The handler expects a value named "ContextDocument" in the context in which it is created. - That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the + That is, the com::sun::star::uno::XComponentContext used for creating the CellBindingPropertyHandler is examined for a value with this name. If the object in this - value denotes a XML form document (indicated by supporting the <type scope="com::sun::star::xforms">XFormsSupplier</type> + value denotes a XML form document (indicated by supporting the com::sun::star::xforms::XFormsSupplier interface), this document is used to examine the XML submissions which the button can be bound to.</p> @see com::sun::star::inspection::XPropertyHandler diff --git a/offapi/com/sun/star/form/inspection/XMLFormsPropertyHandler.idl b/offapi/com/sun/star/form/inspection/XMLFormsPropertyHandler.idl index 0662637c1ee1..2301a4261766 100644 --- a/offapi/com/sun/star/form/inspection/XMLFormsPropertyHandler.idl +++ b/offapi/com/sun/star/form/inspection/XMLFormsPropertyHandler.idl @@ -26,20 +26,20 @@ module com { module sun { module star { module form { module inspection { -/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type> +/** implements a property handler for use with an com::sun::star::inspection::ObjectInspector which provides properties related to binding form control models to XForm bindings. - <p>The handler introduces new properties to choose an <type scope="com::sun::star::xforms">XModel</type> - and a <type scope="com::sun::star::xforms">Binding</type> within this model. Additionally, + <p>The handler introduces new properties to choose an com::sun::star::xforms::XModel + and a com::sun::star::xforms::Binding within this model. Additionally, it introduces properties which reflect the different facets of the binding (e.g. <member scope="com::sun::star::xforms">Binding::BindingExpression</member>), so they can be changed - directly in the <type scope="com::sun::star::inspection">ObjectInspector</type> as if they were a + directly in the com::sun::star::inspection::ObjectInspector as if they were a property of the form component which is being inspected.</p> <p>The handler expects a value named "ContextDocument" in the context in which it is created. - That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the + That is, the com::sun::star::uno::XComponentContext used for creating the CellBindingPropertyHandler is examined for a value with this name. If the object in this - value denotes a XML form document (indicated by supporting the <type scope="com::sun::star::xforms">XFormsSupplier</type> + value denotes a XML form document (indicated by supporting the com::sun::star::xforms::XFormsSupplier interface), this document is used to do XML binding related work.</p> @see com::sun::star::inspection::XPropertyHandler diff --git a/offapi/com/sun/star/form/inspection/XSDValidationPropertyHandler.idl b/offapi/com/sun/star/form/inspection/XSDValidationPropertyHandler.idl index a7b68694a696..17501ce1070f 100644 --- a/offapi/com/sun/star/form/inspection/XSDValidationPropertyHandler.idl +++ b/offapi/com/sun/star/form/inspection/XSDValidationPropertyHandler.idl @@ -26,22 +26,22 @@ module com { module sun { module star { module form { module inspection { -/** implements a property handler for use with an <type scope="com::sun::star::inspection">ObjectInspector</type> +/** implements a property handler for use with an com::sun::star::inspection::ObjectInspector which provides properties related to binding form control models to XForm bindings and validating the form control content. - <p>By using an XMLFormsPropertyHandler, an <type scope="com::sun::star::inspection">ObjectInspector</type> - can be used to bind form components to <type scope="com::sun::star::xforms">Binding</type> instances. + <p>By using an XMLFormsPropertyHandler, an com::sun::star::inspection::ObjectInspector + can be used to bind form components to com::sun::star::xforms::Binding instances. Since those instances also support validating form control content (by supporting an - <type scope="com::sun::star::form::validation">XValidator</type> interface), it seems reasonable to + com::sun::star::form::validation::XValidator interface), it seems reasonable to edit those validate-related properties (like the XSD data type to validate against) in the - <type scope="com::sun::star::inspection">ObjectInspector</type>, too. This is what an XSDValidationPropertyHandler + com::sun::star::inspection::ObjectInspector, too. This is what an XSDValidationPropertyHandler is good for.</p> <p>The handler expects a value named "ContextDocument" in the context in which it is created. - That is, the <type scope="com::sun::star::uno">XComponentContext</type> used for creating the + That is, the com::sun::star::uno::XComponentContext used for creating the CellBindingPropertyHandler is examined for a value with this name. If the object in this - value denotes a XML form document (indicated by supporting the <type scope="com::sun::star::xforms">XFormsSupplier</type> + value denotes a XML form document (indicated by supporting the com::sun::star::xforms::XFormsSupplier interface), this document is used to do XML binding related work.</p> @see com::sun::star::inspection::XPropertyHandler diff --git a/offapi/com/sun/star/form/runtime/FormFeature.idl b/offapi/com/sun/star/form/runtime/FormFeature.idl index 6e9bb37428b2..a59573e1bc39 100644 --- a/offapi/com/sun/star/form/runtime/FormFeature.idl +++ b/offapi/com/sun/star/form/runtime/FormFeature.idl @@ -80,7 +80,7 @@ constants FormFeature const short UndoRecordChanges = 9; /** deletes the current record, while honoring any registered - <type scope="com::sun::star::form">XConfirmDeleteListener</type>s + com::sun::star::form::XConfirmDeleteListeners */ const short DeleteRecord = 10; diff --git a/offapi/com/sun/star/form/runtime/FormOperations.idl b/offapi/com/sun/star/form/runtime/FormOperations.idl index be90f4f04564..b3723d73b3b3 100644 --- a/offapi/com/sun/star/form/runtime/FormOperations.idl +++ b/offapi/com/sun/star/form/runtime/FormOperations.idl @@ -36,11 +36,11 @@ module com { module sun { module star { module form { module runtime { */ service FormOperations : XFormOperations { - /** creates a <code>FormOperations</code> instance which works on a <type scope="com::sun::star::form">FormController</type> + /** creates a <code>FormOperations</code> instance which works on a com::sun::star::form::FormController instance. @throws IllegalArgumentException if the given form controller is <NULL/>, or does not have a model denoting a valid - <type scope="com::sun::star::form::component">DataForm</type> instance. + com::sun::star::form::component::DataForm instance. */ createWithFormController( [in] XFormController Controller @@ -49,11 +49,11 @@ service FormOperations : XFormOperations ::com::sun::star::lang::IllegalArgumentException ); - /** creates a <code>FormOperations</code> instance which works on a <type scope="com::sun::star::form::component">DataForm</type> + /** creates a <code>FormOperations</code> instance which works on a com::sun::star::form::component::DataForm instance. @throws IllegalArgumentException - if the given form is <NULL/>, or does not support the <type scope="com::sun::star::form::component">DataForm</type> + if the given form is <NULL/>, or does not support the com::sun::star::form::component::DataForm service. */ createWithForm( diff --git a/offapi/com/sun/star/form/runtime/XFormController.idl b/offapi/com/sun/star/form/runtime/XFormController.idl index 79f4cf81eb8b..e38a473f1066 100644 --- a/offapi/com/sun/star/form/runtime/XFormController.idl +++ b/offapi/com/sun/star/form/runtime/XFormController.idl @@ -62,10 +62,10 @@ interface XFormControllerContext; else inactive. To be notified whenever this activation state of a given controller changes, you can add listeners.</p> - <p>This interface supersedes the <type scope="com::sun::star::form">FormController</type>.</p> + <p>This interface supersedes the com::sun::star::form::FormController.</p> <h3>Responsibilities</h3> - <p>A FormController is responsible for a <type scope="com::sun::star::awt">UnoControlContainer</type>, + <p>A FormController is responsible for a com::sun::star::awt::UnoControlContainer, and all controls therein.</p> <p>Furthermore, a form controller is responsible for preventing invalid user input. That is, if the form @@ -93,7 +93,7 @@ interface XFormControllerContext; <p>Alternatively, you can prevent the check on a per-control basis, using the <member>DataAwareControlModel::InputRequired</member> property of a single control model.</p> - <p>If a control which the controller is responsible for supports the <type scope="com::sun::star::frame">XDispatchProviderInterception</type> + <p>If a control which the controller is responsible for supports the com::sun::star::frame::XDispatchProviderInterception interface, the controller registers a dispatch interceptor. Then, the control can try to delegate part of its functionality to the controller by querying the dispatch interceptor for it.</p> @@ -106,11 +106,11 @@ interface XFormControllerContext; Example: The URL suffix for deleting the current record is <em>deleteRecord</em>, so the complete URL for requesting a dispatcher for this functionality is <em>.uno:FormController/deleteRecord</em>.</p> - <p>Some URLs may require parameters. For this, the sequence of <type scope="com::sun::star::beans">PropertyValue</type>s + <p>Some URLs may require parameters. For this, the sequence of com::sun::star::beans::PropertyValues passed to the <member scope="com::sun::star::frame">XDispatch::dispatch</member> call is used - every property value is used as one named parameter.</p> - <p>For all URLs, interested parties can register as status listeners (<type scope="com::sun::star::frame">XStatusListener</type>) + <p>For all URLs, interested parties can register as status listeners (com::sun::star::frame::XStatusListener) at the dispatchers, and be notified whenever the functionality associated with the URL becomes enabled or disabled.<br/> For instance, the URL with the suffix <em>moveToFirst</em> is associated with moving the form to the first @@ -133,7 +133,7 @@ interface XFormControllerContext; <tr style="vertical-align: top;"> <td><em>RecordCount</em></td> <td>This is a passive functionality: It cannot be dispatched, instead, interested parties may - use the dispatcher to add as <type scope="com::sun::star::frame">XStatusListener</type>, and be + use the dispatcher to add as com::sun::star::frame::XStatusListener, and be notified when the record count changes.<br/> The status value which is being notified (<member scope="com::sun::star::frame">FeatureStateEvent::State</member>) is a string which can be used to display the record count. In particular, if the record count is not yet known @@ -274,7 +274,7 @@ interface XFormController /** used to notify deletions of data in the form before they happen. <p>A form controller listens for deletion events at the form it is responsible for. If and only if no - <type scope="com::sun::star::form">XConfirmDeleteListener</type> is registered at + com::sun::star::form::XConfirmDeleteListener is registered at the controller, it uses an own dialog to ask the user for confirmation.</p> */ interface ::com::sun::star::form::XConfirmDeleteBroadcaster; @@ -282,7 +282,7 @@ interface XFormController /** is used to notify errors which happen in the form the controller is responsible for. <p>A form controller listens for error events at the form it is responsible for. If and only if no - <type scope="com::sun::star::sdb">XSQLErrorListener</type> is registered at the controller, it + com::sun::star::sdb::XSQLErrorListener is registered at the controller, it uses an own dialog to notify the user of the error.</p> */ @@ -295,7 +295,7 @@ interface XFormController /** is used broadcasting parameter events in the form. <p>A form controller listens for parameter events at the form it is responsible for. If and only if no - <type scope="com::sun::star::form">XDatabaseParameterListener</type> is registered at the controller, it + com::sun::star::form::XDatabaseParameterListener is registered at the controller, it uses an own dialog to ask the user for parameter values.</p> */ interface ::com::sun::star::form::XDatabaseParameterBroadcaster2; diff --git a/offapi/com/sun/star/form/runtime/XFormOperations.idl b/offapi/com/sun/star/form/runtime/XFormOperations.idl index 2e550a9f24cd..c01332788b88 100644 --- a/offapi/com/sun/star/form/runtime/XFormOperations.idl +++ b/offapi/com/sun/star/form/runtime/XFormOperations.idl @@ -56,9 +56,9 @@ interface XFeatureInvalidation; <em>Now</em> you're done ...</p> <p>As another example, consider that you want to delete the current record from the - form. You have to take into account any <type scope="com::sun::star::form">XConfirmDeleteListener</type>s - registered at the <type scope="com::sun::star::form">FormController</type> or the - <type scope="com::sun::star::form::component">DataForm</type>.</p> + form. You have to take into account any com::sun::star::form::XConfirmDeleteListeners + registered at the com::sun::star::form::FormController or the + com::sun::star::form::component::DataForm.</p> <p>If you agree that this is ugly to do and maintain, then <code>XFormOperations</code> is for you. It provides a <member>execute</member> method, which will do all of the above @@ -133,8 +133,8 @@ interface XFormOperations : ::com::sun::star::lang::XComponent if a database access error occurs @throws ::com::sun::star::lang::WrappedTargetException - if an exception is caught which is no <type scope="com::sun::star::uno">RuntimeException</type> - and no <type scope="com::sun::star::sdbc">SQLException</type>. + if an exception is caught which is no com::sun::star::uno::RuntimeException + and no com::sun::star::sdbc::SQLException. @see executeWithArguments */ @@ -166,8 +166,8 @@ interface XFormOperations : ::com::sun::star::lang::XComponent if a database access error occurs @throws ::com::sun::star::lang::WrappedTargetException - if an exception is caught which is no <type scope="com::sun::star::uno">RuntimeException</type> - and no <type scope="com::sun::star::sdbc">SQLException</type>. + if an exception is caught which is no com::sun::star::uno::RuntimeException + and no com::sun::star::sdbc::SQLException. */ void executeWithArguments( [in] short Feature, diff --git a/offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl b/offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl index 910dc9f6b10f..185fb4f45da8 100644 --- a/offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl +++ b/offapi/com/sun/star/form/validation/ValidatableBindableControlModel.idl @@ -30,8 +30,8 @@ module com { module sun { module star { module form { module validation { <p>There are two methods how the value which is represented by a control model can interact with other components (well, except the trivial ones accessible - by using <type scope="com::sun::star::beans">XPropertySet</type>): - <ul><li>binding the value to an external component via <type scope="com::sun::star::form::binding">XBindableValue</type></li> + by using com::sun::star::beans::XPropertySet): + <ul><li>binding the value to an external component via com::sun::star::form::binding::XBindableValue</li> <li>validating the current value by an external component, via XValidatable and XValidator</li> </ul></p> @@ -53,7 +53,7 @@ service ValidatableBindableControlModel established as validator, as if it has been passed to <member>XValidatable::setValidator</member>.<br/> If, while this binding is active (in both its roles as value binding and validator), an attempt is made to establish another validator, this is blocked with raising a - <type scope="com::sun::star::util">VetoException</type> upon calling <member>XValidatable::setValidator</member>.</p> + com::sun::star::util::VetoException upon calling <member>XValidatable::setValidator</member>.</p> */ service com::sun::star::form::binding::BindableControlModel; }; diff --git a/offapi/com/sun/star/form/validation/ValidatableControlModel.idl b/offapi/com/sun/star/form/validation/ValidatableControlModel.idl index e290947efa89..330038662b6b 100644 --- a/offapi/com/sun/star/form/validation/ValidatableControlModel.idl +++ b/offapi/com/sun/star/form/validation/ValidatableControlModel.idl @@ -39,7 +39,7 @@ service ValidatableControlModel /** specifies the basic functionality for a form control model <p>Via this service, validatable control models inherit the - <type scope="com::sun::star::util">XCloneable</type> interface.<br/> + com::sun::star::util::XCloneable interface.<br/> If an validatable control model, at which a validator has been set (via <member>XValidatable::setValidator</member>), is being cloned, then the validator is also set at the clone. Effectively, this means that diff --git a/offapi/com/sun/star/form/validation/XValidatable.idl b/offapi/com/sun/star/form/validation/XValidatable.idl index ce1abe559e19..b16197bee711 100644 --- a/offapi/com/sun/star/form/validation/XValidatable.idl +++ b/offapi/com/sun/star/form/validation/XValidatable.idl @@ -43,7 +43,7 @@ interface XValidatable : com::sun::star::uno::XInterface the new validator which is to be used by the component. May be <NULL/>, in this case only the current validator is revoked. - @throws <type scope="com::sun::star::util">VetoException</type> + @throws com::sun::star::util::VetoException if changing the validator is not allowed in the current component state */ void setValidator( [in] XValidator Validator ) diff --git a/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl b/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl index 4aac6820129d..a1c332a86f85 100644 --- a/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl +++ b/offapi/com/sun/star/form/validation/XValidatableFormComponent.idl @@ -72,7 +72,7 @@ interface XValidatableFormComponent : XValidatable <p>The type of the current value, as well as it's semantics, depend on the service implementing this interface.</p> - <p>Again, this is a convenience method. For example, for a <type scope="com::sun::star::form::component">FormattedField</type>, + <p>Again, this is a convenience method. For example, for a com::sun::star::form::component::FormattedField, calling this method is equivalent to retrieving the <member scope="com::sun::star::awt">UnoControlFormattedFieldModel::EffectiveValue</member>.</p> @@ -86,7 +86,7 @@ interface XValidatableFormComponent : XValidatable <p>XFormComponentValidityListeners are called whenever <em>any</em> of the aspects of the validatable form component (the validity flag, or the value) changed.</p> - @throws <type scope="com::sun::star::lang">NullPointerException</type> + @throws com::sun::star::lang::NullPointerException if the given listener is <NULL/> */ void addFormComponentValidityListener( [in] XFormComponentValidityListener Listener ) @@ -94,7 +94,7 @@ interface XValidatableFormComponent : XValidatable /** registers the given listener. - @throws <type scope="com::sun::star::lang">NullPointerException</type> + @throws com::sun::star::lang::NullPointerException if the given listener is <NULL/> */ void removeFormComponentValidityListener( [in] XFormComponentValidityListener Listener ) diff --git a/offapi/com/sun/star/form/validation/XValidator.idl b/offapi/com/sun/star/form/validation/XValidator.idl index 31a2f95e43d1..0b1096949e04 100644 --- a/offapi/com/sun/star/form/validation/XValidator.idl +++ b/offapi/com/sun/star/form/validation/XValidator.idl @@ -68,7 +68,7 @@ interface XValidator : com::sun::star::uno::XInterface <p>Implementations which do not support dynamic validity constraints should simply ignore this call.</p> - @throws <type scope="com::sun::star::lang">NullPointerException</type> + @throws com::sun::star::lang::NullPointerException if the given listener is <NULL/> @see XValidityConstraintListener */ @@ -77,7 +77,7 @@ interface XValidator : com::sun::star::uno::XInterface /** revokes the given validity listener - @throws <type scope="com::sun::star::lang">NullPointerException</type> + @throws com::sun::star::lang::NullPointerException if the given listener is <NULL/> @see XValidityConstraintListener */ |