Home | History | Annotate | Download | only in clipboard 
      1 /*
      2  * Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions
      6  * are met:
      7  * 1. Redistributions of source code must retain the above copyright
      8  *    notice, this list of conditions and the following disclaimer.
      9  * 2. Redistributions in binary form must reproduce the above copyright
     10  *    notice, this list of conditions and the following disclaimer in the
     11  *    documentation and/or other materials provided with the distribution.
     12  *
     13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
     14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
     17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
     21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     24  */
     25 
     26 #ifndef Pasteboard_h
     27 #define Pasteboard_h
     28 
     29 #include "platform/heap/Handle.h"
     30 #include "public/platform/WebClipboard.h"
     31 #include "wtf/Forward.h"
     32 #include "wtf/Noncopyable.h"
     33 #include "wtf/text/WTFString.h"
     34 
     35 namespace blink {
     36 
     37 class DataObject;
     38 class Image;
     39 class KURL;
     40 
     41 class Pasteboard {
     42     WTF_MAKE_NONCOPYABLE(Pasteboard); WTF_MAKE_FAST_ALLOCATED;
     43 public:
     44     enum SmartReplaceOption {
     45         CanSmartReplace,
     46         CannotSmartReplace
     47     };
     48 
     49     static Pasteboard* generalPasteboard();
     50     void writePlainText(const String&, SmartReplaceOption);
     51     void writeImage(Image*, const KURL&, const String& title);
     52     void writeDataObject(PassRefPtrWillBeRawPtr<DataObject>);
     53     bool canSmartReplace();
     54     bool isHTMLAvailable();
     55     String plainText();
     56 
     57     // If no data is read, an empty string will be returned and all out parameters will be cleared.
     58     // If applicable, the page URL will be assigned to the KURL parameter.
     59     // fragmentStart and fragmentEnd are indexes into the returned markup that indicate
     60     // the start and end of the returned markup. If there is no additional context,
     61     // fragmentStart will be zero and fragmentEnd will be the same as the length of the markup.
     62     String readHTML(KURL&, unsigned& fragmentStart, unsigned& fragmentEnd);
     63 
     64     void writeHTML(const String& markup, const KURL& documentURL, const String& plainText, bool canSmartCopyOrDelete);
     65 
     66     bool isSelectionMode() const;
     67     void setSelectionMode(bool);
     68 
     69     blink::WebClipboard::Buffer buffer() const { return m_buffer; }
     70 
     71 private:
     72     Pasteboard();
     73 
     74     blink::WebClipboard::Buffer m_buffer;
     75 };
     76 
     77 } // namespace blink
     78 
     79 #endif // Pasteboard_h
     80