widget/gtk/nsClipboard.h
author Martin Stransky <stransky@redhat.com>
Tue, 27 Mar 2018 15:51:07 +0200
changeset 460806 f555ad8e039e173dd5b4e399d5d312d351c26cc6
parent 450518 64a1d5998ef049326e6662e74cec56ac656efd2b
child 460807 418c75e8af6ce069471d7a31732249ecbc6e8e58
permissions -rw-r--r--
Bug 1447925 - Add GetClipboardText() to get text data from clipboard, r=jhorak a=jcristau GetClipboardText() calls gtk_clipboard_request_text() to request text clipboard data from Gtk+ and leave Gtk+ to do clipboard text format conversions. Also unify data getting code for text/data/targets. MozReview-Commit-ID: 9DGSdOACho1

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* vim:expandtab:shiftwidth=4:tabstop=4:
 */
/* 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/. */

#ifndef __nsClipboard_h_
#define __nsClipboard_h_

#include "nsIClipboard.h"
#include "nsIObserver.h"
#include "nsIBinaryOutputStream.h"
#include <gtk/gtk.h>

// Default Gtk MIME for text
#define GTK_DEFAULT_MIME_TEXT "UTF8_STRING"

class nsRetrievalContext {
public:
    virtual const char* GetClipboardData(const char* aMimeType,
                                         int32_t aWhichClipboard,
                                         uint32_t* aContentLength) = 0;
    virtual const char* GetClipboardText(int32_t aWhichClipboard) = 0;
    virtual void ReleaseClipboardData(const char* aClipboardData) = 0;

    virtual GdkAtom* GetTargets(int32_t aWhichClipboard,
                                int* aTargetNum) = 0;

    nsRetrievalContext() {};
    virtual ~nsRetrievalContext() {};

protected:
    // Idle timeout for receiving selection and property notify events (microsec)
    static const int kClipboardTimeout;
};

class nsClipboard : public nsIClipboard,
                    public nsIObserver
{
public:
    nsClipboard();

    NS_DECL_ISUPPORTS
    NS_DECL_NSIOBSERVER
    NS_DECL_NSICLIPBOARD

    // Make sure we are initialized, called from the factory
    // constructor
    nsresult  Init              (void);

    // Someone requested the selection
    void   SelectionGetEvent    (GtkClipboard     *aGtkClipboard,
                                 GtkSelectionData *aSelectionData);
    void   SelectionClearEvent  (GtkClipboard     *aGtkClipboard);

private:
    virtual ~nsClipboard();

    // Save global clipboard content to gtk
    nsresult         Store            (void);

    // Get our hands on the correct transferable, given a specific
    // clipboard
    nsITransferable *GetTransferable  (int32_t aWhichClipboard);

    // Send clipboard data by nsITransferable
    void             SetTransferableData(nsITransferable* aTransferable,
                                         nsCString& aFlavor,
                                         const char* aClipboardData,
                                         uint32_t aClipboardDataLength);

    // Hang on to our owners and transferables so we can transfer data
    // when asked.
    nsCOMPtr<nsIClipboardOwner>    mSelectionOwner;
    nsCOMPtr<nsIClipboardOwner>    mGlobalOwner;
    nsCOMPtr<nsITransferable>      mSelectionTransferable;
    nsCOMPtr<nsITransferable>      mGlobalTransferable;
    nsAutoPtr<nsRetrievalContext>  mContext;
};

GdkAtom GetSelectionAtom(int32_t aWhichClipboard);

#endif /* __nsClipboard_h_ */