include/svtools/stringtransfer.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 <config_options.h>
  23 #include <svtools/svtdllapi.h>
  24 #include <vcl/transfer.hxx>
  25
  26
  27 namespace svt
  28 {
  29     //= OStringTransferable
  30     class SVT_DLLPUBLIC OStringTransferable final : public TransferDataContainer
  31     {
  32     public:
  33         OStringTransferable(const OUString& rContent);
  34         void SetData(const OUString& rContent);
  35
  36     private:
  37         // TransferableHelper overridables
  38         virtual void AddSupportedFormats() override;
  39         virtual bool GetData( const css::datatransfer::DataFlavor& _rFlavor, const OUString& rDestDoc ) override;
  40
  41         OUString     m_sContent;
  42     };
  43
  44
  45     //= OStringTransfer
  46     class OStringTransfer
  47     {
  48     public:
  49         /** copies the string given into the system clipboard
  50             <p>Beware: In opposite to the old DragServer::CopyString, this method does not <em>add</em> the string
  51             to the clipboard, instead the old clipboard content is <em>replaced</em>!</p>
  52         */
  53         SVT_DLLPUBLIC static void           CopyString( const OUString& _rContent, vcl::Window* _pWindow );
  54
  55         /** extracts a string from the system clipboard given
  56             @return <TRUE/> if the extraction was successful, i.e. if the clipboard contained a string content
  57         */
  58         SVT_DLLPUBLIC static bool           PasteString( OUString& _rContent, vcl::Window* _pWindow );
  59
  60         /** starts dragging a simple string
  61         */
  62         SVT_DLLPUBLIC static void           StartStringDrag( const OUString& _rContent, vcl::Window* _pWindow, sal_Int8 _nDragSourceActions );
  63     };
  64
  65 }   // namespace svt
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */