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