dbaccess/source/ui/inc/callbacks.hxx

   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 #pragma once
  21
  22 #include <sot/exchange.hxx>
  23
  24 class Point;
  25 struct AcceptDropEvent;
  26 struct ExecuteDropEvent;
  27
  28 namespace comphelper { class OInterfaceContainerHelper2; }
  29
  30 namespace vcl
  31 {
  32     class Window;
  33 }
  34
  35 namespace weld
  36 {
  37     class TreeIter;
  38     class TreeView;
  39 }
  40
  41 namespace dbaui
  42 {
  43
  44     class IController;
  45     // IControlActionListener
  46     class SAL_NO_VTABLE IControlActionListener
  47     {
  48     public:
  49         /** requests a quick help text to display
  50             @return <FALSE/> if the default quick help text should be used
  51         */
  52         virtual bool    requestQuickHelp(const void* pUserData, OUString& rText) const = 0;
  53
  54         /** handler for StartDrag requests
  55             @return <TRUE/> if a drag operation was started
  56         */
  57         virtual bool    requestDrag(const weld::TreeIter& rEntry) = 0;
  58
  59         /** check whether or not a drop request should be accepted
  60         */
  61         virtual sal_Int8    queryDrop( const AcceptDropEvent& _rEvt, const DataFlavorExVector& _rFlavors ) = 0;
  62
  63         /** execute a drop request
  64         */
  65         virtual sal_Int8    executeDrop( const ExecuteDropEvent& _rEvt ) = 0;
  66
  67     protected:
  68         ~IControlActionListener() {}
  69     };
  70
  71     // IContextMenuProvider
  72     class SAL_NO_VTABLE IContextMenuProvider
  73     {
  74     public:
  75         /** returns the context menu resource name for the control
  76
  77             Supposed to be a valid name from uiconfig/<module>/popupmenu folder.
  78         */
  79         virtual OUString getContextMenuResourceName() const = 0;
  80
  81         /** returns the controller which is responsible for providing states of certain features,
  82             and executing them.
  83         */
  84         virtual IController&    getCommandController() = 0;
  85
  86         /** returns the container of registered context menu interceptors, or NULL if the implementation
  87             does not support context menu interception
  88         */
  89         virtual ::comphelper::OInterfaceContainerHelper2*
  90                                 getContextMenuInterceptors() = 0;
  91
  92         /** returns the current selection in the given control
  93
  94             This selection is used for filling a ContextMenuExecuteEvent event for the given
  95             control.
  96         */
  97         virtual css::uno::Any  getCurrentSelection(weld::TreeView& rControl) const = 0;
  98
  99         virtual vcl::Window* getMenuParent() const = 0;
 100
 101         /** adjust rPos which is initially relative to rControl to be relative to
 102             the window of getMenuParent
 103         */
 104         virtual void adjustMenuPosition(const weld::TreeView& rControl, ::Point& rPos) const = 0;
 105
 106     protected:
 107         ~IContextMenuProvider() {}
 108     };
 109
 110     // IDragTransferableListener
 111     class SAL_NO_VTABLE IDragTransferableListener
 112     {
 113     public:
 114         /// called when a drag operation done with a Transferable has been finished
 115         virtual void        dragFinished( ) = 0;
 116
 117     protected:
 118         ~IDragTransferableListener() {}
 119     };
 120
 121 }   // namespace dbaui
 122
 123 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */