INTEGRATION: CWS formdesign01 (1.4.208); FILE MERGED

2004/01/09 12:31:52 fs 1.4.208.1: allow for editing an independent SQL command
This commit is contained in:
Oliver Bolte 2004-03-19 11:25:05 +00:00
parent 0c37d1b9d7
commit 7b944cf7f3

View file

@ -2,9 +2,9 @@
*
* $RCSfile: QueryDesign.idl,v $
*
* $Revision: 1.4 $
* $Revision: 1.5 $
*
* last change: $Author: rt $ $Date: 2003-04-17 10:09:00 $
* last change: $Author: obo $ $Date: 2004-03-19 12:25:05 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@ -87,10 +87,6 @@ module com { module sun { module star { module sdb {
in the selection of the SQL statement or criterias which narrow the query.</p>
@see com::sun::star::sdb::ContentLoader
@see com::sun::star::frame::XDispatch
@see com::sun::star::frame::XDispatchProviderInterceptor
@since #107627#
*/
service QueryDesign
@ -109,25 +105,65 @@ service QueryDesign
to be used.<br>
Recognized parameters are:
<ul>
<li><b>Frame</b><br>
<li margin-top="8px"><b>Frame</b><br>
has to be an <type scope="com::sun::star::frame">XFrame</type> interface specifying the frame to plug the
QueryDesign component into.
QueryDesign component into.<br/>
This parameter is mandatory.
</li>
<li><b>DataSourceName</b><br>
The name of the globally registered <service>DataSource</service> to be used for initial display. It is only
meaningful together with the other parameters specifying the object to display.
<li margin-top="8px"><a name="data_source"/><b>DataSourceName</b><br>
The name of the globally registered <type>DataSource</type> for which a query or view
is to be designed.<br/>
The DataSourceName may be omitted if and only if a valid <a href="#active_connection">ActiveConnection</a>
parameter is present.
</li>
<li><b>CurrentQuery</b><br>
This is a string giving the name of the object to display initially.
<li margin-top="8px"><a name="active_connection"/><b>ActiveConnection</b><br>
The connection to work with.<br/>
May be ommitted if and only if a valid <a href="#data_source">DataSourceName</a> parameter is supplied.
</li>
<li><b>QueryDesignView</b><br>
<li margin-top="8px"><b>CurrentQuery</b><br>
If the component should be used to design an existing query, it's name has to be specified as CurrentQuery
parameter.<br/>
If the <a href="#data_source">DataSourceName</a> parameter is present, the query is looked up
in the specified data source. If <a href="#data_source">DataSourceName</a> is not present, the component
tries to determine the data source which the <a href="#active_connection">ActiveConnection</a> belongs
to, and looks up the query there.<br/>
If this parameter is not present, a new query will be designed.<br/>
This parameter is ignored if <a href="#independent">IndependentSQLCommand</a> is set to <TRUE/>.
</li>
<li margin-top="8px"><b>QueryDesignView</b><br>
This value indicates if the QueryDesign should be opened in the design view or in the text view.
If set to </TRUE> than the design view will be displayed otherwise the text view will appear.
If set to </TRUE> than the design view will be displayed otherwise the text view will appear.<br/>
If not present, <FALSE/> is assumed for this parameter.
</li>
<li margin-top="8px"><b>CreateView</b><br/>
Indicates whether the component should be used to create a server-side view in the database (set to <TRUE/>),
or a client-side query in the data source. There are some differences in both modi, e.g. the component closes
itself when a view is being saved, since a view cannot be modified after creation.<br/>
If not present, <FALSE/> is assumed for this parameter.<br/>
This parameter is ignored if <a href="#independent">IndependentSQLCommand</a> is set to <TRUE/>.
</li>
<li margin-top="8px"><a name=independent"/><b>IndependentSQLCommand</b><br/>
Allows to use the component to design an SQL command which is neither to be stored as server-side view,
nor as a client-side query. Instead, when the user attempts to save the designed SQL statement,
the <member>ActiveCommand</member> property of the component is updated. Whoever invoked the
query design with IndependentSQLCommand being <TRUE/> is then responsible for listening at this property,
and reacting appropriately on its changes.<br/>
If not present, <FALSE/> is assumed for this parameter.
</li>
</ul>
</p>
*/
interface com::sun::star::lang::XInitialization;
/** reflects the designed SQL command at the moment it was last saved by the user.
*/
[readonly, property] string ActiveCommand;
};
//=============================================================================