From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- offapi/com/sun/star/sdb/DataSourceBrowser.idl | 268 ++++++++++++++++++++++++++ 1 file changed, 268 insertions(+) create mode 100644 offapi/com/sun/star/sdb/DataSourceBrowser.idl (limited to 'offapi/com/sun/star/sdb/DataSourceBrowser.idl') diff --git a/offapi/com/sun/star/sdb/DataSourceBrowser.idl b/offapi/com/sun/star/sdb/DataSourceBrowser.idl new file mode 100644 index 000000000..615fc0639 --- /dev/null +++ b/offapi/com/sun/star/sdb/DataSourceBrowser.idl @@ -0,0 +1,268 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * 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 regarding copyright + * ownership. The ASF licenses this file 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 . + */ + + +#ifndef __com_sun_star_sdb_DataSourceBrowser_idl__ +#define __com_sun_star_sdb_DataSourceBrowser_idl__ + +#include +#include +#include +#include +#include + +module com { module sun { module star { module sdb { + +/** implements a component which allows browsing the data sources registered on the system. + +

+ This service implements a user interface for browsing data sources registered on the + com::sun::star::sdb::DatabaseContext + instance of the system. +

+ +

+ It is possible to navigate through all the data sources, it's queries and it's tables. + The queries/tables can be displayed in a grid-like view, where functionality for searching, + sorting, filtering, and such is provided. +

+ +

+ Usually, you won't instantiate this service directly, instead you use the dispatch mechanisms + of the application framework to load the URL .component:DB/DataSourceBrowser into an arbitrary + frame. This should involve a + com::sun::star::sdb::ContentLoader + service, which creates and initializes + the browser. +

+ +

+ Some aspects of the browser can be controlled from outside, e.g., + it is possible to dispatch a sort or filter + request, if a table or query is being displayed. +

+ +

The communication between the browser and external instances works in two ways. +
+ The way in is provided by the + com::sun::star::frame::XDispatchProvider + interface the service exports (Please see below for more details on this). +
+ The way out works in another way. There are several URLs which an external + instance can provide dispatches for (usually by implementing a + com::sun::star::frame::XDispatchProviderInterceptor + for the parent frame of the browser), thus indicating that the browser should provide special functionality. +
+ In this case, the browser displays and maintains some additional slots (to be more concrete: toolbox items), which, + upon triggering, call the + com::sun::star::frame::XDispatch::dispatch() method of the object + provided by the external instance. +

+ +

+ In particular, the supported URLs for communicating to an external instance are: +

    +
  • .uno:DataSourceBrowser/InsertColumns +
    + Available whenever an external instance provides a dispatcher ( + com::sun::star::frame::XDispatch) + for this URL. +
    + Enabled, if at least one row in the grid view of a table or query is selected. +
    + It is the task of the external instance to provide functionality for this URL, but usually it is used + to implement some kind of "Data To Text" functionality. +
    +
    • +
  • .uno:DataSourceBrowser/InsertContent +
    + Available whenever an external instance provides a dispatcher( + com::sun::star::frame::XDispatch + ) for this URL. +
    + Enabled, if at least one row in the grid view of a table or query is selected. +
    + It is the task of the external instance to provide functionality for this URL, but usually it is used + to implement some kind of "Data To Fields" functionality. +
    +
    • +
  • .uno:DataSourceBrowser/FormLetter +
    + Available whenever an external instance provides a dispatcher ( + com::sun::star::frame::XDispatch) for this URL. +
    + It is the task of the external instance to provide functionality for this URL, but usually it is used + to implement some kind of "Form Letter" functionality. +
    +
    • +
+

+

For all kinds of URLs, the parameters supplied during dispatching build up a DataAccessDescriptor, + where the following properties are present: +

    +
  • DataAccessDescriptor::DataSourceName
    • +
  • DataAccessDescriptor::Command
    • +
  • DataAccessDescriptor::CommandType
    • +
  • optional DataAccessDescriptor::Selection
    • +
  • optional DataAccessDescriptor::BookmarkSelection
    • +
  • optional DataAccessDescriptor::ResultSet
    • +
+

+

The default for DataAccessDescriptor::Selection is to contain bookmarks, if not specified + otherwise by DataAccessDescriptor::BookmarkSelection. +

+ + @see com::sun::star::sdb::ContentLoader + @see com::sun::star::sdb::DatabaseContext + @see com::sun::star::sdb::DataSource + @see com::sun::star::frame::XDispatch + @see com::sun::star::frame::XDispatchProvider + @see com::sun::star::frame::XDispatchProviderInterceptor +*/ +published service DataSourceBrowser +{ + /** implements basic form controller functionality. +

+ With a data source browser implementing this interface, external components have access to +

  • the grid control which is used to display the currently selected table/query + (see com::sun::star::awt::XTabController::getControls()) +
    • +
  • the data form used for displaying objects. As always for components implementing this service, + the object returned by + com::sun::star::awt::XTabController::getModel() is a dataform. +
    • +
+

+ */ + [optional] service com::sun::star::form::FormController; + + /** allows the component to be plugged into frames. + */ + interface com::sun::star::frame::XController; + + /** is used to initialize the browser. + +

+ Parameters (passed to the method com::sun::star::lang::XInitialization::initialize()) + have to be instances of com::sun::star::beans::PropertyValue, or + instances of com::sun::star::beans::NamedValue, where the Name member + specifies what the parameter controls, with the Value member containing the value to be used. +
+ Recognized parameters are: +

    +
  • Frame
    + has to be an com::sun::star::frame::XFrame interface specifying the frame to + plug the browser component into.
    • + +
  • DataSourceName
    + The name of the globally registered DataSource to be used for initial display. It is only + meaningful together with the other parameters specifying the object to display.
    • + +
  • CommandType
    + This has to be a CommandType value, specifying the type of the object to display initially. + It is only meaningful together with the DataSourceName and the Command parameters.
    • + +
  • Command
    + This is a string giving the name of the object to display initially. Whether it is table name, a query + name or a SQL string is controller by the CommandType parameter.
    • + +
  • EnableBrowser
    + is a boolean value (defaulting to `TRUE`), which specifies whether to enable the data source browser + control. This is a tree control on the left hand side of the view, which allows to browse all registered + data sources, including their tables and queries.
    • + +
  • ShowBrowser
    + is a boolean value (defaulting to `TRUE`), which specifies whether to initially show the data source + browser control. If EnableBrowser is `FALSE`, then this parameter is ignored. If + EnableBrowser is `TRUE`, and ShowBrowser is `FALSE`, then the control + is initially hidden, but can be toggled by a toolbar button.

    + +
  • ShowMenu
    + is a boolean value (defaulting to `TRUE`), specifying whether or not to show a menu in the frame + where the component is plugged.
    • +
+

+ */ + interface com::sun::star::lang::XInitialization; + + /** is used to control the browser from outside. + +

+ You may use the + com::sun::star::frame::XDispatchProvider::queryDispatch() + method + to query for objects which implement the + com::sun::star::frame::XDispatch + interface, + and which allow you to be notified on status changes and to dispatch special requests. +

+

+ The recognized URLs are: +

    +
  • .uno:Copy +
    + implements the usual Copy command. Enabled if the grid view has the focus and text in any cell + is selected. +
    • +
  • .uno:Cut +
    + implements the usual Cut command. Enabled if the grid view has the focus and text in any cell + is selected. +
    • +
  • .uno:Paste +
    + implements the usual Paste command. Enabled if the grid view has the focus and a cell which + allows text input is being edited. +
    • +
  • .uno:EditDoc +
    + allows switching the edit mode of the grid view. Enabled if editing the data is allowed in general. +
    • +
  • .uno:Undo +
    + revokes any changes done in the current row. +
    • +
  • .uno:Save
    + saves the changes done in the current row. +
    • +
+

+ */ + interface com::sun::star::frame::XDispatchProvider; + + /** allows to intercept user-triggered context menus in the data source browser + +

Context menu interception is currently supported only for the browser control where the registered + data sources and all their tables and queries are displayed in a tree view.

+ +

The selection supplied by com::sun::star::ui::ContextMenuExecuteEvent::Selection, + in the event structure passed to the context menu interceptors, actually is a value from the + com::sun::star::sdb::application::NamedDatabaseObject group.

+ + @since OOo 3.0 + */ + [optional] interface ::com::sun::star::ui::XContextMenuInterception; +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3