git.sesse.net Git - casparcg/blob - dependencies64/cef/include/cef_render_handler.h

   1 // Copyright (c) 2012 Marshall A. Greenblatt. All rights reserved.
   2 //
   3 // Redistribution and use in source and binary forms, with or without
   4 // modification, are permitted provided that the following conditions are
   5 // met:
   6 //
   7 //    * Redistributions of source code must retain the above copyright
   8 // notice, this list of conditions and the following disclaimer.
   9 //    * Redistributions in binary form must reproduce the above
  10 // copyright notice, this list of conditions and the following disclaimer
  11 // in the documentation and/or other materials provided with the
  12 // distribution.
  13 //    * Neither the name of Google Inc. nor the name Chromium Embedded
  14 // Framework nor the names of its contributors may be used to endorse
  15 // or promote products derived from this software without specific prior
  16 // written permission.
  17 //
  18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 //
  30 // ---------------------------------------------------------------------------
  31 //
  32 // The contents of this file must follow a specific format in order to
  33 // support the CEF translator tool. See the translator.README.txt file in the
  34 // tools directory for more information.
  35 //
  36
  37 #ifndef CEF_INCLUDE_CEF_RENDER_HANDLER_H_
  38 #define CEF_INCLUDE_CEF_RENDER_HANDLER_H_
  39 #pragma once
  40
  41 #include "include/cef_base.h"
  42 #include "include/cef_browser.h"
  43 #include "include/cef_drag_data.h"
  44 #include <vector>
  45
  46 ///
  47 // Implement this interface to handle events when window rendering is disabled.
  48 // The methods of this class will be called on the UI thread.
  49 ///
  50 /*--cef(source=client)--*/
  51 class CefRenderHandler : public virtual CefBase {
  52  public:
  53   typedef cef_cursor_type_t CursorType;
  54   typedef cef_drag_operations_mask_t DragOperation;
  55   typedef cef_drag_operations_mask_t DragOperationsMask;
  56   typedef cef_paint_element_type_t PaintElementType;
  57   typedef std::vector<CefRect> RectList;
  58
  59   ///
  60   // Called to retrieve the root window rectangle in screen coordinates. Return
  61   // true if the rectangle was provided.
  62   ///
  63   /*--cef()--*/
  64   virtual bool GetRootScreenRect(CefRefPtr<CefBrowser> browser,
  65                                  CefRect& rect) { return false; }
  66
  67   ///
  68   // Called to retrieve the view rectangle which is relative to screen
  69   // coordinates. Return true if the rectangle was provided.
  70   ///
  71   /*--cef()--*/
  72   virtual bool GetViewRect(CefRefPtr<CefBrowser> browser, CefRect& rect) =0;
  73
  74   ///
  75   // Called to retrieve the translation from view coordinates to actual screen
  76   // coordinates. Return true if the screen coordinates were provided.
  77   ///
  78   /*--cef()--*/
  79   virtual bool GetScreenPoint(CefRefPtr<CefBrowser> browser,
  80                               int viewX,
  81                               int viewY,
  82                               int& screenX,
  83                               int& screenY) { return false; }
  84
  85   ///
  86   // Called to allow the client to fill in the CefScreenInfo object with
  87   // appropriate values. Return true if the |screen_info| structure has been
  88   // modified.
  89   //
  90   // If the screen info rectangle is left empty the rectangle from GetViewRect
  91   // will be used. If the rectangle is still empty or invalid popups may not be
  92   // drawn correctly.
  93   ///
  94   /*--cef()--*/
  95   virtual bool GetScreenInfo(CefRefPtr<CefBrowser> browser,
  96                              CefScreenInfo& screen_info) { return false; }
  97
  98   ///
  99   // Called when the browser wants to show or hide the popup widget. The popup
 100   // should be shown if |show| is true and hidden if |show| is false.
 101   ///
 102   /*--cef()--*/
 103   virtual void OnPopupShow(CefRefPtr<CefBrowser> browser,
 104                            bool show) {}
 105
 106   ///
 107   // Called when the browser wants to move or resize the popup widget. |rect|
 108   // contains the new location and size in view coordinates.
 109   ///
 110   /*--cef()--*/
 111   virtual void OnPopupSize(CefRefPtr<CefBrowser> browser,
 112                            const CefRect& rect) {}
 113
 114   ///
 115   // Called when an element should be painted. Pixel values passed to this
 116   // method are scaled relative to view coordinates based on the value of
 117   // CefScreenInfo.device_scale_factor returned from GetScreenInfo. |type|
 118   // indicates whether the element is the view or the popup widget. |buffer|
 119   // contains the pixel data for the whole image. |dirtyRects| contains the set
 120   // of rectangles in pixel coordinates that need to be repainted. |buffer| will
 121   // be |width|*|height|*4 bytes in size and represents a BGRA image with an
 122   // upper-left origin.
 123   ///
 124   /*--cef()--*/
 125   virtual void OnPaint(CefRefPtr<CefBrowser> browser,
 126                        PaintElementType type,
 127                        const RectList& dirtyRects,
 128                        const void* buffer,
 129                        int width, int height) =0;
 130
 131   ///
 132   // Called when the browser's cursor has changed. If |type| is CT_CUSTOM then
 133   // |custom_cursor_info| will be populated with the custom cursor information.
 134   ///
 135   /*--cef()--*/
 136   virtual void OnCursorChange(CefRefPtr<CefBrowser> browser,
 137                               CefCursorHandle cursor,
 138                               CursorType type,
 139                               const CefCursorInfo& custom_cursor_info) {}
 140
 141   ///
 142   // Called when the user starts dragging content in the web view. Contextual
 143   // information about the dragged content is supplied by |drag_data|.
 144   // (|x|, |y|) is the drag start location in screen coordinates.
 145   // OS APIs that run a system message loop may be used within the
 146   // StartDragging call.
 147   //
 148   // Return false to abort the drag operation. Don't call any of
 149   // CefBrowserHost::DragSource*Ended* methods after returning false.
 150   //
 151   // Return true to handle the drag operation. Call
 152   // CefBrowserHost::DragSourceEndedAt and DragSourceSystemDragEnded either
 153   // synchronously or asynchronously to inform the web view that the drag
 154   // operation has ended.
 155   ///
 156   /*--cef()--*/
 157   virtual bool StartDragging(CefRefPtr<CefBrowser> browser,
 158                              CefRefPtr<CefDragData> drag_data,
 159                              DragOperationsMask allowed_ops,
 160                              int x, int y) { return false; }
 161
 162   ///
 163   // Called when the web view wants to update the mouse cursor during a
 164   // drag & drop operation. |operation| describes the allowed operation
 165   // (none, move, copy, link).
 166   ///
 167   /*--cef()--*/
 168   virtual void UpdateDragCursor(CefRefPtr<CefBrowser> browser,
 169                                 DragOperation operation) {}
 170
 171   ///
 172   // Called when the scroll offset has changed.
 173   ///
 174   /*--cef()--*/
 175   virtual void OnScrollOffsetChanged(CefRefPtr<CefBrowser> browser,
 176                                      double x,
 177                                      double y) {}
 178 };
 179
 180 #endif  // CEF_INCLUDE_CEF_RENDER_HANDLER_H_