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