cef/include/cef_drag_data.h

233 lines
6.6 KiB
C++

// Copyright (c) 2013 Marshall A. Greenblatt. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the name Chromium Embedded
// Framework nor the names of its contributors may be used to endorse
// or promote products derived from this software without specific prior
// written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// ---------------------------------------------------------------------------
//
// The contents of this file must follow a specific format in order to
// support the CEF translator tool. See the translator.README.txt file in the
// tools directory for more information.
//
#ifndef CEF_INCLUDE_CEF_DRAG_DATA_H_
#define CEF_INCLUDE_CEF_DRAG_DATA_H_
#pragma once
#include <vector>
#include "include/cef_base.h"
#include "include/cef_image.h"
#include "include/cef_stream.h"
///
/// Class used to represent drag data. The methods of this class may be called
/// on any thread.
///
/*--cef(source=library)--*/
class CefDragData : public virtual CefBaseRefCounted {
public:
///
/// Create a new CefDragData object.
///
/*--cef()--*/
static CefRefPtr<CefDragData> Create();
///
/// Returns a copy of the current object.
///
/*--cef()--*/
virtual CefRefPtr<CefDragData> Clone() = 0;
///
/// Returns true if this object is read-only.
///
/*--cef()--*/
virtual bool IsReadOnly() = 0;
///
/// Returns true if the drag data is a link.
///
/*--cef()--*/
virtual bool IsLink() = 0;
///
/// Returns true if the drag data is a text or html fragment.
///
/*--cef()--*/
virtual bool IsFragment() = 0;
///
/// Returns true if the drag data is a file.
///
/*--cef()--*/
virtual bool IsFile() = 0;
///
/// Return the link URL that is being dragged.
///
/*--cef()--*/
virtual CefString GetLinkURL() = 0;
///
/// Return the title associated with the link being dragged.
///
/*--cef()--*/
virtual CefString GetLinkTitle() = 0;
///
/// Return the metadata, if any, associated with the link being dragged.
///
/*--cef()--*/
virtual CefString GetLinkMetadata() = 0;
///
/// Return the plain text fragment that is being dragged.
///
/*--cef()--*/
virtual CefString GetFragmentText() = 0;
///
/// Return the text/html fragment that is being dragged.
///
/*--cef()--*/
virtual CefString GetFragmentHtml() = 0;
///
/// Return the base URL that the fragment came from. This value is used for
/// resolving relative URLs and may be empty.
///
/*--cef()--*/
virtual CefString GetFragmentBaseURL() = 0;
///
/// Return the name of the file being dragged out of the browser window.
///
/*--cef()--*/
virtual CefString GetFileName() = 0;
///
/// Write the contents of the file being dragged out of the web view into
/// |writer|. Returns the number of bytes sent to |writer|. If |writer| is
/// NULL this method will return the size of the file contents in bytes.
/// Call GetFileName() to get a suggested name for the file.
///
/*--cef(optional_param=writer)--*/
virtual size_t GetFileContents(CefRefPtr<CefStreamWriter> writer) = 0;
///
/// Retrieve the list of file names that are being dragged into the browser
/// window.
///
/*--cef()--*/
virtual bool GetFileNames(std::vector<CefString>& names) = 0;
///
/// Retrieve the list of file paths that are being dragged into the browser
/// window.
///
/*--cef()--*/
virtual bool GetFilePaths(std::vector<CefString>& paths) = 0;
///
/// Set the link URL that is being dragged.
///
/*--cef(optional_param=url)--*/
virtual void SetLinkURL(const CefString& url) = 0;
///
/// Set the title associated with the link being dragged.
///
/*--cef(optional_param=title)--*/
virtual void SetLinkTitle(const CefString& title) = 0;
///
/// Set the metadata associated with the link being dragged.
///
/*--cef(optional_param=data)--*/
virtual void SetLinkMetadata(const CefString& data) = 0;
///
/// Set the plain text fragment that is being dragged.
///
/*--cef(optional_param=text)--*/
virtual void SetFragmentText(const CefString& text) = 0;
///
/// Set the text/html fragment that is being dragged.
///
/*--cef(optional_param=html)--*/
virtual void SetFragmentHtml(const CefString& html) = 0;
///
/// Set the base URL that the fragment came from.
///
/*--cef(optional_param=base_url)--*/
virtual void SetFragmentBaseURL(const CefString& base_url) = 0;
///
/// Reset the file contents. You should do this before calling
/// CefBrowserHost::DragTargetDragEnter as the web view does not allow us to
/// drag in this kind of data.
///
/*--cef()--*/
virtual void ResetFileContents() = 0;
///
/// Add a file that is being dragged into the webview.
///
/*--cef(optional_param=display_name)--*/
virtual void AddFile(const CefString& path,
const CefString& display_name) = 0;
///
/// Clear list of filenames.
///
/*--cef()--*/
virtual void ClearFilenames() = 0;
///
/// Get the image representation of drag data. May return NULL if no image
/// representation is available.
///
/*--cef()--*/
virtual CefRefPtr<CefImage> GetImage() = 0;
///
/// Get the image hotspot (drag start location relative to image dimensions).
///
/*--cef()--*/
virtual CefPoint GetImageHotspot() = 0;
///
/// Returns true if an image representation of drag data is available.
///
/*--cef()--*/
virtual bool HasImage() = 0;
};
#endif // CEF_INCLUDE_CEF_DRAG_DATA_H_