/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_datatransfer_clipboard_XClipboard_idl__
#define __com_sun_star_datatransfer_clipboard_XClipboard_idl__

#include <com/sun/star/datatransfer/XTransferable.idl>
#include <com/sun/star/uno/XInterface.idl>


module com { module sun { module star { module datatransfer { module clipboard {

/** The default interface to access clipboard instances.
*/

 published interface XClipboardListener;
 published interface XClipboardOwner;

published interface XClipboard: com::sun::star::uno::XInterface
{
    /** To get the current content of the clipboard.

        @returns
        The transferable object representing the current content of
        this clipboard.

        @see com::sun::star::datatransfer::XTransferable
    */
    com::sun::star::datatransfer::XTransferable getContents();

    /** Sets the current contents of the clipboard to the specified
        transferable object and registers the specified clipboard owner
        as the owner of the new contents.

        @param xTrans
        The transferable object to set as new content.
        <p>If the given com::sun::star::datatransfer::XTransferable
        has no com::sun::star::datatransfer::DataFlavor the clipboard
        will be deleted.
        <p>A NULL value is not allowed.</p>

        @param xClipboardOwner
        The new owner of the clipboard.
        <p>NULL is an acceptable value and means that the
        caller is not interested in lost ownership notifications.</p>

        @see com::sun::star::datatransfer::XTransferable
        @see com::sun::star::datatransfer::clipboard::XClipboardOwner
    */
    void setContents( [in] com::sun::star::datatransfer::XTransferable xTrans, [in] XClipboardOwner xClipboardOwner );

    /** To get the name of the clipboard instance.

        @returns
        The name of this clipboard object.
        <p>If the returned string is empty the
        clipboard instance is the system clipboard.</p>
    */
    string getName();
};


}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */