LibreOffice
LibreOffice 6.2 SDK API Reference
Exported Interfaces | Public Attributes | List of all members
QueryDesign Service Referencepublished

implements a component which allows the creation of SQL statements. More...

import"QueryDesign.idl";

Inheritance diagram for QueryDesign:
XController XInitialization XComponent XInterface XInterface

Exported Interfaces

interface com::sun::star::frame::XController
 allows the component to be plugged into frames. More...
 
interface com::sun::star::lang::XInitialization
 is used to initialize the QueryDesign. More...
 

Public Attributes

string ActiveCommand
 reflects the designed SQL command at the moment it was last saved by the user. More...
 
boolean EscapeProcessing
 specifies whether the user enabled escape processing for the statement being designed. More...
 

Additional Inherited Members

- Public Member Functions inherited from XController
void attachFrame ([in] XFrame Frame)
 is called to attach the controller with its managing frame. More...
 
boolean attachModel ([in] XModel Model)
 is called to attach the controller to a new model. More...
 
boolean suspend ([in] boolean Suspend)
 is called to prepare the controller for closing the view More...
 
any getViewData ()
 provides access to current view status More...
 
void restoreViewData ([in] any Data)
 restores the view status using the data gotten from a previous call to XController::getViewData(). More...
 
XModel getModel ()
 provides access to currently attached model More...
 
XFrame getFrame ()
 provides access to owner frame of this controller More...
 
- Public Member Functions inherited from XComponent
void dispose ()
 The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
 
void addEventListener ([in] XEventListener xListener)
 adds an event listener to the object. More...
 
void removeEventListener ([in] XEventListener aListener)
 removes an event listener from the listener list. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Public Member Functions inherited from XInitialization
void initialize ([in] sequence< any > aArguments) raises ( com::sun::star::uno::Exception )
 initializes the object. More...
 

Detailed Description

implements a component which allows the creation of SQL statements.

This service implements a user interface for creating SQL statements either through a graphical design interface or simply to enter the SQL statement directly.

The design view of the QueryDesign is divided into two parts. The first part contains the table windows where columns can be selected for the SQL statement. The second part contains the columns which should appear in the selection of the SQL statement or criteria which narrow the query.

Operation Modes

A QueryDesign component has 3 operation modes, which control what kind of object is edited:

Initialization

Initialization is done using the com::sun::star::lang::XInitialization interface, which expects a sequence of objects being either com::sun::star::beans::NamedValues or com::sun::star::beans::PropertyValues. The following parameters are supported at initialization time:

There's a number of legacy settings which are recognized for compatibility reasons, though you're discouraged from using them:

See also
com::sun::star::sdb::ContentLoader

Exported Interfaces

allows the component to be plugged into frames.

is used to initialize the QueryDesign.

See chapter Initialization for details.

Member Data Documentation

string ActiveCommand
propertyreadonly

reflects the designed SQL command at the moment it was last saved by the user.

boolean EscapeProcessing
optionalpropertyreadonly

specifies whether the user enabled escape processing for the statement being designed.

See also
DataAccessDescriptor::EscapeProcessing
Since
OOo 2.4

The documentation for this service was generated from the following file: