This is an automated email from the ASF dual-hosted git repository.
mseidel pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/openoffice.git
The following commit(s) were added to refs/heads/trunk by this push:
new 0c85547 Fixed typos, removed whitespace
0c85547 is described below
commit 0c85547751d28076cc4afd0024c8fad5cb6b3da1
Author: mseidel <msei...@apache.org>
AuthorDate: Fri Sep 13 17:33:07 2019 +0200
Fixed typos, removed whitespace
---
.../com/sun/star/form/DataAwareControlModel.idl | 175 ++++++++++-----------
.../sun/star/form/PropertyBrowserController.idl | 65 ++++----
2 files changed, 119 insertions(+), 121 deletions(-)
diff --git a/main/offapi/com/sun/star/form/DataAwareControlModel.idl
b/main/offapi/com/sun/star/form/DataAwareControlModel.idl
index 5dfbe33..49400a3 100644
--- a/main/offapi/com/sun/star/form/DataAwareControlModel.idl
+++ b/main/offapi/com/sun/star/form/DataAwareControlModel.idl
@@ -1,5 +1,5 @@
/**************************************************************
- *
+ *
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@@ -7,87 +7,86 @@
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
- *
+ *
*************************************************************/
-#ifndef __com_sun_star_form_DataAwareControlModel_idl__
-#define __com_sun_star_form_DataAwareControlModel_idl__
-
-#ifndef __com_sun_star_form_FormControlModel_idl__
-#include <com/sun/star/form/FormControlModel.idl>
-#endif
-
-#ifndef __com_sun_star_form_XBoundComponent_idl__
-#include <com/sun/star/form/XBoundComponent.idl>
-#endif
-
-#ifndef __com_sun_star_form_XLoadListener_idl__
-#include <com/sun/star/form/XLoadListener.idl>
-#endif
-
-#ifndef __com_sun_star_form_XReset_idl__
-#include <com/sun/star/form/XReset.idl>
-#endif
-
-#ifndef __com_sun_star_beans_XPropertySet_idl__
-#include <com/sun/star/beans/XPropertySet.idl>
-#endif
-
-
-//=============================================================================
-
- module com { module sun { module star { module form {
-
-//=============================================================================
-
+#ifndef __com_sun_star_form_DataAwareControlModel_idl__
+#define __com_sun_star_form_DataAwareControlModel_idl__
+
+#ifndef __com_sun_star_form_FormControlModel_idl__
+#include <com/sun/star/form/FormControlModel.idl>
+#endif
+
+#ifndef __com_sun_star_form_XBoundComponent_idl__
+#include <com/sun/star/form/XBoundComponent.idl>
+#endif
+
+#ifndef __com_sun_star_form_XLoadListener_idl__
+#include <com/sun/star/form/XLoadListener.idl>
+#endif
+
+#ifndef __com_sun_star_form_XReset_idl__
+#include <com/sun/star/form/XReset.idl>
+#endif
+
+#ifndef __com_sun_star_beans_XPropertySet_idl__
+#include <com/sun/star/beans/XPropertySet.idl>
+#endif
+
+//=============================================================================
+
+ module com { module sun { module star { module form {
+
+//=============================================================================
+
/** is an abstract service for specialized <type>FormControlModel</type>s
which are data aware and thus can be bound to a data source.
- <p>The connection between a data-aware control model and a form which's
data the
+ <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
via the <type>FormControlModel</type> and <type>FormComponent</type>
services) has
always to be a <type
scope="com::sun::star::form::component">DataForm</type>.</p>
*/
published service DataAwareControlModel
-{
- service com::sun::star::form::FormControlModel;
-
+{
+ service com::sun::star::form::FormControlModel;
+
/** makes it possible to transfer the data of the model to the
connected data field.
<p>
This interface is optional, if a component doesn't support it,
it has to forward
- the changes of it's value to the field it is connected to
immediately (means whenever a user
- interaction changes it's content).
+ the changes of its value to the field it is connected to
immediately (means whenever a user
+ interaction changes its content).
</p>
*/
- [optional] interface com::sun::star::form::XBoundComponent;
-
-
+ [optional] interface com::sun::star::form::XBoundComponent;
+
+
/** must be implemented in order to recognize when the containing form
of the model connects
- to its data source (loads its data). After loading the form,
the model may bind to its
+ to its data source (loads its data). After loading the form,
the model may bind to its
related field source.<br/>
This interface will seldom be used directly from outside.
*/
- interface com::sun::star::form::XLoadListener;
-
-
- /** Each <type>DataAwareControlModel</type> should be resettable for
setting default values.
+ interface com::sun::star::form::XLoadListener;
+
+
+ /** Each <type>DataAwareControlModel</type> should be resettable for
setting default values.
<p>In the context of a control model which is data-aware, the
semantics of <em>default value</em>
(see <type>XReset</type>) is as follows:<br/>
- If (and only if) the control is valid bound to a column of it's
<typee scope="com::sun::star::form::component">DataForm</type>, and the form
+ If (and only if) the control is valid bound to a column of its
<type scope="com::sun::star::form::component">DataForm</type>, 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
+ <member>XReset::reset</member> does not reset the model's value
to its 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>
@@ -98,16 +97,16 @@ published service DataAwareControlModel
<p>In the context of a <type
scope="com::sun::star::form::component">DataForm</type>, controls are
automatically reset when one of the following applies
- <ul><li>The form is reset by invoking it's <type>XReset</type>
interface.</li>
+ <ul><li>The form is reset by invoking its <type>XReset</type>
interface.</li>
<li>The form moves to a new record.</li>
<li>The changes in the current record of the form are
undone</li>
</ul>
</p>
*/
- interface com::sun::star::form::XReset;
-
-
//-------------------------------------------------------------------------
-
+ interface com::sun::star::form::XReset;
+
+
//-------------------------------------------------------------------------
+
/** 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
@@ -120,44 +119,44 @@ published service DataAwareControlModel
@see DataAwareControlModel::BoundField
*/
- [property] string DataField;
-
- /** determines whether or not input into this field is required, when it
is actually bound to a database field.
-
- <p>If this property is set to <FALSE/>, then the form runtime will not
check the control/model for
- <NULL/> values before submitting data to the database. Usually, if a
control model is bound to
- a database field which cannot be <NULL/>, and the model itself does
not have a value, then the database
- update is prevented, showing an error message to the user. To disable
this behavior on a per-control
- basis, use the <code>InputRequired</code> property.</p>
-
- @since OpenOffice 3.1
- */
- [optional, property] boolean InputRequired;
-
-
//-------------------------------------------------------------------------
-
+ [property] string DataField;
+
+ /** determines whether or not input into this field is required, when
it is actually bound to a database field.
+
+ <p>If this property is set to <FALSE/>, then the form runtime
will not check the control/model for
+ <NULL/> values before submitting data to the database. Usually,
if a control model is bound to
+ a database field which cannot be <NULL/>, and the model itself
does not have a value, then the database
+ update is prevented, showing an error message to the user. To
disable this behavior on a per-control
+ basis, use the <code>InputRequired</code> property.</p>
+
+ @since OpenOffice 3.1
+ */
+ [optional, property] boolean InputRequired;
+
+
//-------------------------------------------------------------------------
+
/** 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.
</p>
@see DataAwareControlModel::DataField
*/
- [readonly, property] com::sun::star::beans::XPropertySet BoundField;
-
-
//-------------------------------------------------------------------------
+ [readonly, property] com::sun::star::beans::XPropertySet BoundField;
+
+
//-------------------------------------------------------------------------
/** references to a control model within the same document which should
be used as a label.
<p>Any user interface action which needs to refer to the
control is assumed to use this
- property. <br/>
+ 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
column of your data source. Then you will probably add a
- <type scope="com::sun::star::form::component">FixedText</type>
which's label is "E-Mail",
+ <type scope="com::sun::star::form::component">FixedText</type>
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>.
+ examine its label, and use this label to refer to the <type
scope="com::sun::star::form::component">TextField</type>.
</p>
<p>When setting the property, a number of constraints apply:
<ul>
@@ -168,24 +167,24 @@ published service DataAwareControlModel
<li><type
scope="com::sun::star::container">XChild</type></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>It has to be a part of the same document as the
model whose 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
- labelled 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 labelled
+ 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.
</li>
</ul>
</p>
*/
- [property] com::sun::star::beans::XPropertySet LabelControl;
-
-};
-
-//=============================================================================
-
-}; }; }; };
-
+ [property] com::sun::star::beans::XPropertySet LabelControl;
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
#endif
diff --git a/main/offapi/com/sun/star/form/PropertyBrowserController.idl
b/main/offapi/com/sun/star/form/PropertyBrowserController.idl
index f9b7cce..604c1bc 100644
--- a/main/offapi/com/sun/star/form/PropertyBrowserController.idl
+++ b/main/offapi/com/sun/star/form/PropertyBrowserController.idl
@@ -1,5 +1,5 @@
/**************************************************************
- *
+ *
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
@@ -7,54 +7,53 @@
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
- *
+ *
*************************************************************/
+#ifndef __com_sun_star_form_PropertyBrowserController_idl__
+#define __com_sun_star_form_PropertyBrowserController_idl__
-#ifndef __com_sun_star_form_PropertyBrowserController_idl__
-#define __com_sun_star_form_PropertyBrowserController_idl__
-
-#ifndef __com_sun_star_frame_XController_idl__
-#include <com/sun/star/frame/XController.idl>
+#ifndef __com_sun_star_frame_XController_idl__
+#include <com/sun/star/frame/XController.idl>
#endif
-#ifndef __com_sun_star_beans_XPropertySet_idl__
-#include <com/sun/star/beans/XPropertySet.idl>
+#ifndef __com_sun_star_beans_XPropertySet_idl__
+#include <com/sun/star/beans/XPropertySet.idl>
#endif
-#ifndef __com_sun_star_beans_XFastPropertySet_idl__
-#include <com/sun/star/beans/XFastPropertySet.idl>
+#ifndef __com_sun_star_beans_XFastPropertySet_idl__
+#include <com/sun/star/beans/XFastPropertySet.idl>
#endif
-#ifndef __com_sun_star_beans_XMultiPropertySet_idl__
-#include <com/sun/star/beans/XMultiPropertySet.idl>
+#ifndef __com_sun_star_beans_XMultiPropertySet_idl__
+#include <com/sun/star/beans/XMultiPropertySet.idl>
#endif
-//=============================================================================
-
- module com { module sun { module star { module form {
-
-//=============================================================================
+//=============================================================================
+
+ module com { module sun { module star { module form {
+
+//=============================================================================
/** 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
provide a visual component for inspecting control properties. This
means it allows to interactively control
- several aspects of a <type>FormControlModel</type> or
<type>DataAwareControlModel</type>, such as it's
- data binding, it's layout, and it's event binding</p>
+ several aspects of a <type>FormControlModel</type> or
<type>DataAwareControlModel</type>, such as its
+ data binding, its layout, and its event binding</p>
<p>For using a PropertyBrowserController, you need to
- <ul><li>instatiate it at a service factory of your choice</li>
+ <ul><li>instantiate it at a service factory of your choice</li>
<li>attach it to an empty frame of your choice</li>
<li>set the IntrospectedObject property to the control model
which you wish to analyze</li>
</ul>
@@ -83,17 +82,17 @@
@see com::sun::star::frame::XController
- @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>
+ @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>
*/
published service PropertyBrowserController
{
/** contains the object to inspect.
- <p>Changing this property from outside causes the controller to
update it's view
+ <p>Changing this property from outside causes the controller to
update its view
with the data of the new object</p>
*/
[property] com::sun::star::beans::XPropertySet IntrospectedObject;
@@ -106,7 +105,7 @@ published service PropertyBrowserController
The appearance of the visual component created by the
controller is that 3 tab pages, one for
each group, are displayed (of course if the control does not
support any aspects of a given group,
the group is omitted).<br/>
- With this property, it can be controller which page is
currently acticve.</p>
+ With this property, it can be controller which page is
currently active.</p>
<p>Valid values are (this list may be extended in the future):
<ul><li>Generic</li>
@@ -136,8 +135,8 @@ published service PropertyBrowserController
interface com::sun::star::beans::XMultiPropertySet;
};
-//=============================================================================
-
-}; }; }; };
-
+//=============================================================================
+
+}; }; }; };
+
#endif
