include/vcl/dndhelp.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 #ifndef INCLUDED_VCL_DNDHELP_HXX
  21 #define INCLUDED_VCL_DNDHELP_HXX
  22
  23 #include <vcl/dllapi.h>
  24 #include <cppuhelper/weak.hxx>
  25 #include <com/sun/star/datatransfer/dnd/XDragGestureListener.hpp>
  26 #include <com/sun/star/datatransfer/dnd/XDragSourceListener.hpp>
  27 #include <com/sun/star/datatransfer/dnd/XDropTargetListener.hpp>
  28
  29 namespace com::sun::star::datatransfer::dnd {
  30     struct DragGestureEvent;
  31     struct DragSourceDragEvent;
  32     struct DragSourceDropEvent;
  33     struct DragSourceEvent;
  34     struct DropTargetDragEvent;
  35     struct DropTargetDragEnterEvent;
  36     struct DropTargetDropEvent;
  37     struct DropTargetEvent;
  38 }
  39
  40 namespace vcl::unohelper
  41 {
  42
  43 class VCL_DLLPUBLIC DragAndDropClient
  44 {
  45 public:
  46     virtual ~DragAndDropClient() COVERITY_NOEXCEPT_FALSE;
  47
  48     // css::datatransfer::dnd::XDragGestureListener
  49     /// @throws css::uno::RuntimeException
  50     SAL_DLLPRIVATE virtual void dragGestureRecognized( const css::datatransfer::dnd::DragGestureEvent& dge );
  51
  52     // css::datatransfer::dnd::XDragSourceListener
  53     /// @throws css::uno::RuntimeException
  54     SAL_DLLPRIVATE virtual void dragDropEnd(const css::datatransfer::dnd::DragSourceDropEvent& dsde );
  55
  56     // css::datatransfer::dnd::XDropTargetListener
  57     /// @throws css::uno::RuntimeException
  58     SAL_DLLPRIVATE virtual void drop( const css::datatransfer::dnd::DropTargetDropEvent& dtde );
  59     /// @throws css::uno::RuntimeException
  60     SAL_DLLPRIVATE virtual void dragEnter( const css::datatransfer::dnd::DropTargetDragEnterEvent& dtdee );
  61     /// @throws css::uno::RuntimeException
  62     SAL_DLLPRIVATE virtual void dragExit( const css::datatransfer::dnd::DropTargetEvent& dte );
  63     /// @throws css::uno::RuntimeException
  64     SAL_DLLPRIVATE virtual void dragOver( const css::datatransfer::dnd::DropTargetDragEvent& dtde );
  65 };
  66
  67 class DragAndDropWrapper final :
  68                             public css::datatransfer::dnd::XDragGestureListener,
  69                             public css::datatransfer::dnd::XDragSourceListener,
  70                             public css::datatransfer::dnd::XDropTargetListener,
  71                             public ::cppu::OWeakObject
  72 {
  73 private:
  74     DragAndDropClient* mpClient;
  75
  76 public:
  77     VCL_DLLPUBLIC   DragAndDropWrapper( DragAndDropClient* pClient );
  78                     virtual ~DragAndDropWrapper() override;
  79
  80     // css::uno::XInterface
  81     css::uno::Any SAL_CALL queryInterface( const css::uno::Type & rType ) override;
  82     void          SAL_CALL acquire() noexcept override  { OWeakObject::acquire(); }
  83     void          SAL_CALL release() noexcept override  { OWeakObject::release(); }
  84
  85     // css::lang::XEventListener
  86     void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
  87
  88     // css::datatransfer::dnd::XDragGestureListener
  89     void SAL_CALL dragGestureRecognized( const css::datatransfer::dnd::DragGestureEvent& dge ) override;
  90
  91     // css::datatransfer::dnd::XDragSourceListener
  92     void SAL_CALL dragDropEnd( const css::datatransfer::dnd::DragSourceDropEvent& dsde ) override;
  93     void SAL_CALL dragEnter( const css::datatransfer::dnd::DragSourceDragEvent& dsde ) override;
  94     void SAL_CALL dragExit( const css::datatransfer::dnd::DragSourceEvent& dse ) override;
  95     void SAL_CALL dragOver( const css::datatransfer::dnd::DragSourceDragEvent& dsde ) override;
  96     void SAL_CALL dropActionChanged( const css::datatransfer::dnd::DragSourceDragEvent& dsde ) override;
  97
  98     // css::datatransfer::dnd::XDropTargetListener
  99     void SAL_CALL drop( const css::datatransfer::dnd::DropTargetDropEvent& dtde ) override;
 100     void SAL_CALL dragEnter( const css::datatransfer::dnd::DropTargetDragEnterEvent& dtdee ) override;
 101     void SAL_CALL dragExit( const css::datatransfer::dnd::DropTargetEvent& dte ) override;
 102     void SAL_CALL dragOver( const css::datatransfer::dnd::DropTargetDragEvent& dtde ) override;
 103     void SAL_CALL dropActionChanged( const css::datatransfer::dnd::DropTargetDragEvent& dtde ) override;
 104 };
 105
 106 }  // namespace vcl::unohelper
 107
 108 #endif // INCLUDED_VCL_DNDHELP_HXX
 109
 110 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */