You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdelibs/tdeio/tdeio/paste.h

126 lines
4.7 KiB

/* This file is part of the KDE libraries
Copyright (C) 2000-2005 David Faure <faure@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License version 2 as published by the Free Software Foundation.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef __tdeio_paste_h__
#define __tdeio_paste_h__
#include <tqstring.h>
#include <tqmemarray.h>
#include <kurl.h>
class TQWidget;
class TQMimeSource;
// KDE4 TODO pass a parent widget to all methods that will display a message box
namespace TDEIO {
class Job;
class CopyJob;
/**
* Pastes the content of the clipboard to the given destination URL.
* URLs are treated separately (performing a file copy)
* from other data (which is saved into a file after asking the user
* to choose a filename and the preferred data format)
*
* @param destURL the URL to receive the data
* @param move true to move the data, false to copy
* @return the job that handles the operation
* @see pasteData()
*/
TDEIO_EXPORT Job *pasteClipboard( const KURL& destURL, bool move = false );
/**
* Pastes the given @p data to the given destination URL.
* NOTE: This method is blocking (uses NetAccess for saving the data).
* Please consider using pasteDataAsync instead.
*
* @param destURL the URL of the directory where the data will be pasted.
* The filename to use in that directory is prompted by this method.
* @param data the data to copy
* @see pasteClipboard()
*/
TDEIO_EXPORT void pasteData( const KURL& destURL, const TQByteArray& data );
/**
* Pastes the given @p data to the given destination URL.
* Note that this method requires the caller to have chosen the QByteArray
* to paste before hand, unlike pasteClipboard and pasteMimeSource.
*
* @param destURL the URL of the directory where the data will be pasted.
* The filename to use in that directory is prompted by this method.
* @param data the data to copy
* @see pasteClipboard()
*/
TDEIO_EXPORT CopyJob *pasteDataAsync( const KURL& destURL, const TQByteArray& data );
/**
* Pastes the given @p data to the given destination URL.
* Note that this method requires the caller to have chosen the QByteArray
* to paste before hand, unlike pasteClipboard and pasteMimeSource.
*
* @param destURL the URL of the directory where the data will be pasted.
* The filename to use in that directory is prompted by this method.
* @param data the data to copy
* @param dialogText the text to show in the dialog
* @see pasteClipboard()
*/
TDEIO_EXPORT CopyJob *pasteDataAsync( const KURL& destURL, const TQByteArray& data, const TQString& dialogText ); // KDE4: merge with above
/**
* Save the given mimesource @p data to the given destination URL
* after offering the user to choose a data format.
* This is the method used when handling drops (of anything else than URLs)
* onto kdesktop and konqueror.
*
* @param data the TQMimeSource (e.g. a TQDropEvent)
* @param destURL the URL of the directory where the data will be pasted.
* The filename to use in that directory is prompted by this method.
* @param dialogText the text to show in the dialog
* @param widget parent widget to use for dialogs
* @param clipboard whether the TQMimeSource comes from TQClipboard. If you
* use pasteClipboard for that case, you never have to worry about this parameter.
*
* @see pasteClipboard()
*
* @since 3.5
*/
TDEIO_EXPORT CopyJob* pasteMimeSource( TQMimeSource* data, const KURL& destURL,
const TQString& dialogText, TQWidget* widget,
bool clipboard = false );
/**
* Checks whether the clipboard contains any URLs.
* @return true if not
* Not used anymore, wrong method name, so it will disappear in KDE4.
*/
TDEIO_EXPORT_DEPRECATED bool isClipboardEmpty();
/**
* Returns the text to use for the Paste action, when the application supports
* pasting files, urls, and clipboard data, using pasteClipboard().
* @return a string suitable for TDEAction::setText, or an empty string if pasting
* isn't possible right now.
*
* @since 3.5
*/
TDEIO_EXPORT TQString pasteActionText();
}
#endif