offapi/com/sun/star/sdb/application/DefaultViewController.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com { module sun { module star { module sdb { module application {
  22
  23
  24 /** is the default controller implementation for OpenOffice.org's database application.
  25  */
  26 service DefaultViewController
  27 {
  28     /** defines basic controller functionality
  29     */
  30     service ::com::sun::star::frame::Controller;
  31
  32     /** allows intercepting context menu requests done by the user
  33
  34         <p>The ::com::sun::star::ui::ContextMenuExecuteEvent::Selection member
  35         of the event passed to an interceptor will <em>not</em> be the controller itself
  36         (though the controller also supports the <a href="#XSelectionSupplier"><code>XSelectionSupplier</code></a>
  37         interface), but a component which describes the current selection of the very window where the context
  38         menu was requested.</p>
  39
  40         <p>In OpenOffice.org's database application, database objects such as tables, queries, forms,
  41         reports are displayed in a tree-like fashion. Currently, only context menu requests on this tree view
  42         can be intercepted using the <code>XContextMenuInterception</code> interface. Context menu requests
  43         in other places cannot be intercepted.</p>
  44
  45         <p>For the aforementioned tree view, the selection supplied by the <code>ContextMenuEvent::Selection</code>
  46         component is an array of NamedDatabaseObject instances.</p>
  47     */
  48     interface ::com::sun::star::ui::XContextMenuInterception;
  49
  50     /** allows intercepting user input done by the user
  51     */
  52     interface ::com::sun::star::awt::XUserInputInterception;
  53
  54     /** <a name="XSelectionSupplier"></a>
  55         provides access to the current selection inside the application window, and allows to change it
  56         programmatically
  57
  58         <p>The selection is an array of NamedDatabaseObject instances.</p>
  59     */
  60     interface ::com::sun::star::view::XSelectionSupplier;
  61
  62     /** allows to retrieve and set the title which of the component
  63     */
  64     interface ::com::sun::star::frame::XTitle;
  65
  66     /** allows being notified about changes in the component's title
  67     */
  68     interface ::com::sun::star::frame::XTitleChangeBroadcaster;
  69
  70     /** allows programmatic access to aspects of the application's user interface.
  71     */
  72     interface XDatabaseDocumentUI;
  73 };
  74
  75
  76 }; }; }; }; };
  77
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */