summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdb
diff options
context:
space:
mode:
authorMichael Stahl <mstahl@redhat.com>2013-04-27 23:14:19 +0200
committerMichael Stahl <mstahl@redhat.com>2013-06-04 12:01:01 +0200
commit4bb43e1612ea3737fe53bb28ac830810b0a6a028 (patch)
treebd4949cc9c236626941b7995fb390a7090db37b9 /offapi/com/sun/star/sdb
parentea71a05840f53158f669182c6e93de9f8348bbe5 (diff)
*api: replace <member>Foo</member>
These member variables need a # prefix. sed -i "s,<member>\([^<:]\+[^)]\)</member>,#\1,g" Change-Id: I721b90f4edae32b5a362479bdbd60423f6427364
Diffstat (limited to 'offapi/com/sun/star/sdb')
-rw-r--r--offapi/com/sun/star/sdb/DataAccessDescriptor.idl64
-rw-r--r--offapi/com/sun/star/sdb/DataSource.idl10
-rw-r--r--offapi/com/sun/star/sdb/QueryDesign.idl4
-rw-r--r--offapi/com/sun/star/sdb/RowSet.idl16
-rw-r--r--offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl4
-rw-r--r--offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl6
-rw-r--r--offapi/com/sun/star/sdb/application/XCopyTableWizard.idl2
-rw-r--r--offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl2
8 files changed, 54 insertions, 54 deletions
diff --git a/offapi/com/sun/star/sdb/DataAccessDescriptor.idl b/offapi/com/sun/star/sdb/DataAccessDescriptor.idl
index 3041fd90fa71..a2b693a536bb 100644
--- a/offapi/com/sun/star/sdb/DataAccessDescriptor.idl
+++ b/offapi/com/sun/star/sdb/DataAccessDescriptor.idl
@@ -47,7 +47,7 @@ published service DataAccessDescriptor
/** specifies the name of the datasource to access.
<p>This data source is usually used to create a Connection. If no DataSourceName is given
- and the <member>DatabaseLocation</member> and the <member>ConnectionResource</member> are empty, then an <member>ActiveConnection</member>
+ and the #DatabaseLocation and the #ConnectionResource are empty, then an #ActiveConnection
is required.</p>
@see com::sun::star::sdb::DatabaseContext
@@ -58,7 +58,7 @@ published service DataAccessDescriptor
/** specifies the URL of the database file.
<p>This database location is usually used to create a Connection. If no DatabaseLocation is given
- and the <member>ConnectionResource</member> is empty, then an <member>ActiveConnection</member> is required.</p>
+ and the #ConnectionResource is empty, then an #ActiveConnection is required.</p>
@see com::sun::star::sdb::DatabaseContext
@see ActiveConnection
@@ -68,7 +68,7 @@ published service DataAccessDescriptor
/** specifies the database URL which locates a database driver.
<p>This database URL is usually used to create a Connection. If no ConnectionResource is given,
- then an <member>ActiveConnection</member> is required.</p>
+ then an #ActiveConnection is required.</p>
@see com::sun::star::sdb::DatabaseContext
@see ActiveConnection
@@ -90,12 +90,12 @@ published service DataAccessDescriptor
<p>This object is guaranteed to be a com::sun::star::sdbc::Connection, but usually
it will be a Connection from the module com::sun::star::sdb.<br/>
- Especially in the case where no <member>DataSourceName</member> is given, but
- <member>CommandType</member> is <member>CommandType::QUERY</member>, the ActiveConnection needs
+ Especially in the case where no #DataSourceName is given, but
+ #CommandType is <member>CommandType::QUERY</member>, the ActiveConnection needs
to fully support the Connection service, to actually retrieve the query specified by
- <member>Command</member></p>
+ #Command</p>
- <p>If no ActiveConnection is given, then a <member>DataSourceName</member> is required.</p>
+ <p>If no ActiveConnection is given, then a #DataSourceName is required.</p>
@see DataSourceName
*/
@@ -103,7 +103,7 @@ published service DataAccessDescriptor
/** specifies the command to execute to retrieve a result set.
- <p>This property is only meaningful together with the <member>CommandType</member>
+ <p>This property is only meaningful together with the #CommandType
property, thus either <em>both</em> or <em>none</em> of them are present.</p>
@see CommandType
@@ -113,9 +113,9 @@ published service DataAccessDescriptor
/** specifies the type of the command to be executed to retrieve a result set.
- <p><member>Command</member> needs to be interpreted depending on the value of this property.</p>
+ <p>#Command needs to be interpreted depending on the value of this property.</p>
- <p>This property is only meaningful together with the <member>Command</member>
+ <p>This property is only meaningful together with the #Command
property, thus either <em>both</em> or <em>none</em> of them are present.</p>
@see com::sun::star::sdb::CommandType
@@ -127,11 +127,11 @@ published service DataAccessDescriptor
<p>The Filter string has to form a <code>WHERE</code>-clause, <em>without</em> the
<code>WHERE</code>-string itself.</p>
- <p>If a <member>DataSourceName</member>, <member>Command</member> and <member>CommandType</member>
+ <p>If a #DataSourceName, #Command and #CommandType
are specified, a RowSet can be created with this information. If the results provided by the
row set are to be additionally filtered, the Filter property can be used.</p>
- <p>Note that the Filter property does not make sense if a <member>ResultSet</member> has been specified
+ <p>Note that the Filter property does not make sense if a #ResultSet has been specified
in the DataAccessDescriptor.</p>
@see com::sun::star::sdb::RowSet
@@ -140,42 +140,42 @@ published service DataAccessDescriptor
[optional, property] string Filter;
/** specifies an additional <code>ORDER BY</code> clause which should be applied on top of
- the given <member>Command</member>.
+ the given #Command.
<p>The keyword <code>ORDER BY</code> itself is not part of this property.</p>
*/
[optional, property] string Order;
/** specifies an additional <code>HAVING</code> clause which should be applied on top of
- the given <member>Command</member>.
+ the given #Command.
<p>The keyword <code>HAVING</code> itself is not part of this property.</p>
*/
[optional, property] string HavingClause;
/** specifies an additional <code>GROUP BY</code> clause which should be applied on top of
- the given <member>Command</member>.
+ the given #Command.
<p>The keyword <code>GROUP BY</code> itself is not part of this property.</p>
*/
[optional, property] string GroupBy;
- /** specifies if the <member>Command</member> should be analyzed on the client side before sending it
+ /** specifies if the #Command should be analyzed on the client side before sending it
to the database server.
<p>The default value of this property is <TRUE/>. By switching it to <FALSE/>, you can pass
backend-specific SQL statements, which are not standard SQL, to your database.</p>
- <p>This property is usually present together with the <member>Command</member> and
- <member>CommandType</member> properties, and is evaluated if and only if <member>CommandType</member>
+ <p>This property is usually present together with the #Command and
+ #CommandType properties, and is evaluated if and only if #CommandType
equals <member>CommandType::COMMAND</member>.</p>
*/
[optional, property] boolean EscapeProcessing;
/** specifies an already existent result set to use.
- <p>Usually, you use the properties <member>DataSourceName</member> (alternatively
- <member>ActiveConnection</member>), <member>Command</member> and <member>CommandType</member> to specify
+ <p>Usually, you use the properties #DataSourceName (alternatively
+ #ActiveConnection), #Command and #CommandType to specify
how to <em>obtain</em> a result set. However, in scenarios where the provider of a DataAccessDescriptor
has access to an already existent result set, it can pass it along for reusage. This is encouraged
to increase performance.</p>
@@ -187,7 +187,7 @@ published service DataAccessDescriptor
com::sun::star::sdb::RowSet, or an instance obtained
by calling com::sun::star::sdb::XResultSetAccess::createResultSet()
on such a com::sun::star::sdb::RowSet. This becomes important in
- conjunction with the <member>Selection</member> property.</p>
+ conjunction with the #Selection property.</p>
@see com::sun::star::sdb::XResultSetAccess
*/
@@ -195,28 +195,28 @@ published service DataAccessDescriptor
/** specifies a selection to confine the records in a result set.
- <p>When you specify a result set either implicitly (<member>DataSourceName</member>, <member>Command</member>,
- <member>CommandType</member>) or explicitly (<member>ResultSet</member>), the set of results can be
+ <p>When you specify a result set either implicitly (#DataSourceName, #Command,
+ #CommandType) or explicitly (#ResultSet), the set of results can be
additionally refined with this property.</p>
- <p>The single elements of the <member>Selection</member> are either record numbers (see
+ <p>The single elements of the #Selection are either record numbers (see
com::sun::star::sdbc::XResultSet::getRow()), or bookmarks (see
com::sun::star::sdbcx::XRowLocate::getBookmark()).<br/>
It is up to the component which provides or requires a DataAccessDescriptor to specify which of the
two alternatives it expects. If it does <em>not</em> specify this, then the property
- <member>BookmarkSelection</member> becomes mandatory.</p>
+ #BookmarkSelection becomes mandatory.</p>
- <p>If the elements specify bookmarks, and a <member>ResultSet</member> has been specified, then
+ <p>If the elements specify bookmarks, and a #ResultSet has been specified, then
this result set is required to support the com::sun::star::sdbcx::XRowLocate interface.</p>
*/
[optional, property] sequence< any > Selection;
- /** specifies how to interpret <member>Selection</member>
+ /** specifies how to interpret #Selection
- <p>If present, <member>BookmarkSelection</member> specifies the semantics of <member>Selection</member>. If
+ <p>If present, #BookmarkSelection specifies the semantics of #Selection. If
not present, it's up to the implementing component to specify this semantics.</p>
- <p>If <TRUE/>, then the single elements of the array specified by <member>Selection</member> are
+ <p>If <TRUE/>, then the single elements of the array specified by #Selection are
bookmarks relative to the result set, if <FALSE/>, they're record numbers.</p>
@see com::sun::star::sdbcx::XRowLocate
@@ -227,8 +227,8 @@ published service DataAccessDescriptor
/** specifies a column name.
- <p>This property is usually used together with the <member>Command</member> and
- <member>CommandType</member> properties.</p>
+ <p>This property is usually used together with the #Command and
+ #CommandType properties.</p>
@see Column
*/
@@ -238,7 +238,7 @@ published service DataAccessDescriptor
<p>For reasons of performance and saving resources, a supplier of an DataAccessDescriptor which is
used to describe a column object can pass this object directly, instead of specifying it only implicitly
- with the <member>ColumnName</member> property.</p>
+ with the #ColumnName property.</p>
<p>The object will at least support the com::sun::star::sdbcx::Column service, but more
often it will even be a Column from the com::sun::star::sdb module.</p>
diff --git a/offapi/com/sun/star/sdb/DataSource.idl b/offapi/com/sun/star/sdb/DataSource.idl
index ba5bfd625995..0e1cb6ffd092 100644
--- a/offapi/com/sun/star/sdb/DataSource.idl
+++ b/offapi/com/sun/star/sdb/DataSource.idl
@@ -136,15 +136,15 @@ published service DataSource
*/
[property] sequence<com::sun::star::beans::PropertyValue> Info;
- /** is a convenience wrapper around the <member>Info</member> property.
+ /** is a convenience wrapper around the #Info property.
<p>Since fiddling around with a sequence of property values is somewhat uncomfortable
in all known UNO language bindings (especially for tasks like simply changing the value
- of an existing value), the <member>Settings</member> property wraps the <member>Info</member>
+ of an existing value), the #Settings property wraps the #Info
property for easier single-value access.</p>
- <p>You should use the <member>Setting</member> property if you need to access a few properties only,
- and the <member>Info</member> property if you need access to all existent settings at once.</p>
+ <p>You should use the #Setting property if you need to access a few properties only,
+ and the #Info property if you need access to all existent settings at once.</p>
<p>The object represented by this property supports the com::sun::star::beans::PropertyBag
service. That is, you can at runtime add arbitrary new properties to the bag.</p>
@@ -178,7 +178,7 @@ published service DataSource
always made persistent, except when an explicit
<member scope="com::sun::star::beans">PropertyAttribute::TRANSIENT</member> attribute prohibits this.</p>
- <p>Similar, when you obtain the <member>Info</member> property of a <code>DataSource</code>, the
+ <p>Similar, when you obtain the #Info property of a <code>DataSource</code>, the
<code>Settings</code> bag is asked for all its property values, and the ones which are removable and
in state default are stripped, and <em>not</em> returned in the <code>Info</code> sequence.</p>
*/
diff --git a/offapi/com/sun/star/sdb/QueryDesign.idl b/offapi/com/sun/star/sdb/QueryDesign.idl
index 79ca232f3ec3..4b8a3e00a123 100644
--- a/offapi/com/sun/star/sdb/QueryDesign.idl
+++ b/offapi/com/sun/star/sdb/QueryDesign.idl
@@ -52,7 +52,7 @@ module com { module sun { module star { module sdb {
<li><a name="command_mode"</a><b>Command Mode</b>
<p>In <code>Command Mode</code>, the designer is used to design an standalone SQL command.</p>
<p>The client of the designer is then responsible to listen at changes in the
- <member>ActiveCommand</member> and <member>EscapeProcessing</member> members, which are updated
+ #ActiveCommand and #EscapeProcessing members, which are updated
every time the user saves the command.</p></li>
</ul></p>
@@ -105,7 +105,7 @@ module com { module sun { module star { module sdb {
<li><member>CommandType::COMMAND</member> specifies the designer should operate in
<a href="#command_mode">command mode</a>, that is, a standalone SQL command
should be designed. When the user attempts to save the designed SQL statement,
- the <member>ActiveCommand</member> and <member>EscapeProcessing</member> properties
+ the #ActiveCommand and #EscapeProcessing properties
of the designer are updated.</li>
<li><member>CommandType::TABLE</member> specifies the designer should operate in
diff --git a/offapi/com/sun/star/sdb/RowSet.idl b/offapi/com/sun/star/sdb/RowSet.idl
index e79f99341128..c49f84169ca7 100644
--- a/offapi/com/sun/star/sdb/RowSet.idl
+++ b/offapi/com/sun/star/sdb/RowSet.idl
@@ -87,13 +87,13 @@ published interface XParametersSupplier;
</td>
</tr>
<tr><td valign="top"><em>row state</em></td>
- <td valign="top">If the operation leads to a change in the state of the <member>IsModified</member>
- and/or <member>IsNew</member> property, this is notified next (in this order).
+ <td valign="top">If the operation leads to a change in the state of the #IsModified
+ and/or #IsNew property, this is notified next (in this order).
</td>
</tr>
<tr><td valign="top"><em>row count</em></td>
<td valign="top">If the operation leads to new knowledge about the number of rows in the result set,
- the respective changes in the <member>RowCount</member> and <member>IsRowCountFinal</member>
+ the respective changes in the #RowCount and #IsRowCountFinal
are notified last (in this order).
</td>
</tr>
@@ -158,7 +158,7 @@ published interface XParametersSupplier;
<dt>com::sun::star::sdbc::XResultSet: <code>next</code>, <code>first</code>, <code>last</code>, <code>absolute</code>,
<code>relative</code>, <code>previous</code>, <code>beforeFirst</code>, <code>afterLast</code></dt>
- <dd>will let the deleted row vanish from the result set. As a consequence, the <member>RowCount</member>
+ <dd>will let the deleted row vanish from the result set. As a consequence, the #RowCount
will decrease when you do such a move operation after deleting a row.<br/>
A special case to note is the <code>next<code> call: When you delete row, say,
<code>15</code>, followed by <code>next</code>, then your RowSet afterwards
@@ -180,7 +180,7 @@ published interface XParametersSupplier;
<dd>will throw an exception when the cursor is on a deleted row.</dd>
<dt>com::sun::star::sdbc::XResultSetUpdate::moveToInsertRow()</dt>
- <dd>will let the deleted row vanish from the result set. As a consequence, the <member>RowCount</member>
+ <dd>will let the deleted row vanish from the result set. As a consequence, the #RowCount
will decrease. Also, subsequent calls to
com::sun::star::sdbc::XResultSetUpdate::moveToCurrentRow() will not
be able to move back to the deleted row (since it vanished), but only to the
@@ -255,7 +255,7 @@ published service RowSet
/** gives access to the parameters contained in the SQL statement represented by the component.
<p>If your <code>RowSet</code> is bound to an SQL command or query which contains parameters, or has
- a <member>Filter</member> or <member>Order</member> which contains parameters, then those can be accessed
+ a #Filter or #Order which contains parameters, then those can be accessed
using the <code>XParametersSupplier</code> interface.</p>
<p>The returned container contains parameter objects which do allow write access to the parameters (which
@@ -280,8 +280,8 @@ published service RowSet
/** is the command which should be executed, the type of command depends
on the CommandType.
- <p>In case of a <member>CommandType</member> of <member>CommandType::COMMAND</member>,
- means in case the <member>Command</member> specifies an SQL statement, the inherited
+ <p>In case of a #CommandType of <member>CommandType::COMMAND</member>,
+ means in case the #Command specifies an SQL statement, the inherited
<member scope="com::sun::star::sdbc">RowSet::EscapeProcessing</member>
becomes relevant:<br/>
It then can be to used to specify whether the SQL statement should be analyzed on the
diff --git a/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl b/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl
index bc9f8470f568..500c7138f7d2 100644
--- a/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl
+++ b/offapi/com/sun/star/sdb/XSingleSelectQueryAnalyzer.idl
@@ -194,8 +194,8 @@ interface XSingleSelectQueryAnalyzer : com::sun::star::uno::XInterface
is the command which should be executed, the type of command depends
on the CommandType.
- <p>In case of a <member>CommandType</member> of <member>CommandType::COMMAND</member>,
- means in case the <member>Command</member> specifies an SQL statement, the inherited
+ <p>In case of a #CommandType of <member>CommandType::COMMAND</member>,
+ means in case the #Command specifies an SQL statement, the inherited
<member scope="com::sun::star::sdbc">RowSet::EscapeProcessing</member>
becomes relevant:<br/>
It then can be to used to specify whether the SQL statement should be analyzed on the
diff --git a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl
index 5f021f5995c7..68c602b9ed15 100644
--- a/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl
+++ b/offapi/com/sun/star/sdb/XSingleSelectQueryComposer.idl
@@ -199,7 +199,7 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer
the complete composed query.</p>
<p>As a result, you can use the composer to build cumulative filter expressions. That
- is, you can set <member>ElementaryQuery</member> to a statement already containing
+ is, you can set #ElementaryQuery to a statement already containing
filters, and then use setFilter() to append additional filters.</p>
<p>The very same holds for sort orders, <code>HAVING</code> and <code>GROUP BY</code>
@@ -209,7 +209,7 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer
statement represented by a QueryDefinition, and extend it with additional
filters or sort orders, while not touching the respective parts already present
in <member>QueryDefinition::Command</member>. This can be achieved by setting the
- <member>QueryDefinition::Command</member> as <member>ElementaryQuery</member> of a
+ <member>QueryDefinition::Command</member> as #ElementaryQuery of a
SingleSelectQueryComposer.</p>
<p>If, in such a scenario, you would be interested in the filter part of the
@@ -218,7 +218,7 @@ interface XSingleSelectQueryComposer: XSingleSelectQueryAnalyzer
part via XSingleSelectQueryAnalyzer::getFilter().</p>
<p>If you'd be interested in the composed filter, you would set the
- <member>QueryDefinition::Command</member> as <member>ElementaryQuery</member>, add your
+ <member>QueryDefinition::Command</member> as #ElementaryQuery, add your
filter, and propagate the resulting query (XSingleSelectQueryAnalyzer::getQuery())
to an SingleSelectQueryAnalyzer instance via
XSingleSelectQueryAnalyzer::setQuery().</p>
diff --git a/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl b/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl
index c5b462ec9605..6a1968050c53 100644
--- a/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl
+++ b/offapi/com/sun/star/sdb/application/XCopyTableWizard.idl
@@ -93,7 +93,7 @@ interface XCopyTableWizard : ::com::sun::star::ui::dialogs::XExecutableDialog
user can define an arbitrarily complex primary key, e.g. including multiple columns,
which cannot be represented in this simple attribute anymore.</p>
- <p>This attribute is ignored if <member>Operation</member> is
+ <p>This attribute is ignored if #Operation is
<member>CopyTableOperation::AppendData</member>.</p>
<p>Changing this attribute while the dialog is running is not supported, the
diff --git a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl
index 55ee6c1cb743..3e3b88f8e216 100644
--- a/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl
+++ b/offapi/com/sun/star/sdb/application/XDatabaseDocumentUI.idl
@@ -111,7 +111,7 @@ interface XDatabaseDocumentUI
/** identifies the given sub component
@param SubComponent
- the component to identify. Must be one of the components in <member>SubComponents</member>.
+ the component to identify. Must be one of the components in #SubComponents.
@return
a record describing the sub component. The first element of the returned pair is the type