text: // Copyright © 2015 The CefSharp Authors. All rights reserved.
  //
  // Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
  
  #pragma once
  
  #include "Stdafx.h"
  
  #include "include\cef_frame.h"
  #include "include\cef_v8.h"
  #include "CefWrapper.h"
  
  using namespace System::Threading::Tasks;
  
  namespace CefSharp
  {
      namespace Internals
      {
          ///
          // Class used to represent a frame in the browser window. When used in the
          // browser process the methods of this class may be called on any thread unless
          // otherwise indicated in the comments. When used in the render process the
          // methods of this class may only be called on the main thread.
          ///
          /*--cef(source=library)--*/
          private ref class CefFrameWrapper : public IFrame, public CefWrapper
          {
          private:
              MCefRefPtr<CefFrame> _frame;
              IFrame^ _parentFrame;
              IBrowser^ _owningBrowser;
              Object^ _syncRoot;
  
          internal:
              CefFrameWrapper::CefFrameWrapper(CefRefPtr<CefFrame> &frame)
                  : _frame(frame), _parentFrame(nullptr),
                  _owningBrowser(nullptr), _syncRoot(gcnew Object())
              {
              }
  
              !CefFrameWrapper()
              {
                  _frame = NULL;
              }
  
              ~CefFrameWrapper()
              {
                  this->!CefFrameWrapper();
  
                  delete _parentFrame;
                  delete _owningBrowser;
                  _parentFrame = nullptr;
                  _owningBrowser = nullptr;
                  _syncRoot = nullptr;
                  _disposed = true;
              }
  
          public:
              ///
              // True if this object is currently attached to a valid frame.
              ///
              /*--cef()--*/
              virtual property bool IsValid
              {
                  bool get();
              }
  
              ///
              // Execute undo in this frame.
              ///
              /*--cef()--*/
              virtual void Undo();
  
              ///
              // Execute redo in this frame.
              ///
              /*--cef()--*/
              virtual void Redo();
  
              ///
              // Execute cut in this frame.
              ///
              /*--cef()--*/
              virtual void Cut();
  
              ///
              // Execute copy in this frame.
              ///
              /*--cef()--*/
              virtual void Copy();
  
              ///
              // Execute paste in this frame.
              ///
              /*--cef()--*/
              virtual void Paste();
  
              ///
              // Execute delete in this frame.
              ///
              /*--cef(capi_name=del)--*/
              virtual void Delete();
  
              ///
              // Execute select all in this frame.
              ///
              /*--cef()--*/
              virtual void SelectAll();
  
              ///
              // Save this frame's HTML source to a temporary file and open it in the
              // default text viewing application. This method can only be called from the
              // browser process.
              ///
              /*--cef()--*/
              virtual void ViewSource();
  
              ///
              // Retrieve this frame's HTML source as a string sent to the specified
              // visitor.
              ///
              /*--cef()--*/
              virtual Task<String^>^ GetSourceAsync();
  
              ///
              // Retrieve this frame's HTML source as a string sent to the specified
              // visitor.
              ///
              /*--cef()--*/
              virtual void GetSource(IStringVisitor^ visitor);
  
              ///
              // Retrieve this frame's display text as a string sent to the specified
              // visitor.
              ///
              /*--cef()--*/
              virtual Task<String^>^ GetTextAsync();
  
              ///
              // Retrieve this frame's display text as a string sent to the specified
              // visitor.
              ///
              /*--cef()--*/
              virtual void GetText(IStringVisitor^ visitor);
  
              ///
              /// Load the request represented by the |request| object.
              ///
              /*--cef()--*/
              virtual void LoadRequest(IRequest^ request);
  
              ///
              // Load the specified |url|.
              ///
              /*--cef()--*/
              virtual void LoadUrl(String^ url);
  
              ///
              // Load the contents of |html| with the specified dummy |url|. |url|
              // should have a standard scheme (for example, http scheme) or behaviors like
              // link clicks and web security restrictions may not behave as expected.
              ///
              /*--cef()--*/
              virtual void LoadStringForUrl(String^ html, String^ url);
  
              ///
              // Execute a string of JavaScript code in this frame. The |script_url|
              // parameter is the URL where the script in question can be found, if any.
              // The renderer may request this URL to show the developer the source of the
              // error.  The |start_line| parameter is the base line number to use for error
              // reporting.
              ///
              /*--cef(optional_param=script_url)--*/
              virtual void ExecuteJavaScriptAsync(String^ code, String^ scriptUrl, int startLine);
  
              virtual Task<JavascriptResponse^>^ EvaluateScriptAsync(String^ script, String^ scriptUrl, int startLine, Nullable<TimeSpan> timeout);
  
              ///
              // Returns true if this is the main (top-level) frame.
              ///
              /*--cef()--*/
              virtual property bool IsMain
              {
                  bool get();
              }
  
              ///
              // Returns true if this is the focused frame.
              ///
              /*--cef()--*/
              virtual property bool IsFocused
              {
                  bool get();
              }
  
              ///
              // Returns the name for this frame. If the frame has an assigned name (for
              // example, set via the iframe "name" attribute) then that value will be
              // returned. Otherwise a unique name will be constructed based on the frame
              // parent hierarchy. The main (top-level) frame will always have an empty name
              // value.
              ///
              /*--cef()--*/
              virtual property String^ Name
              {
                  String^ get();
              }
  
              ///
              // Returns the globally unique identifier for this frame.
              ///
              /*--cef()--*/
              virtual property Int64 Identifier
              {
                  Int64 get();
              }
  
              ///
              // Returns the parent of this frame or NULL if this is the main (top-level)
              // frame.
              ///
              /*--cef()--*/
              virtual property IFrame^ Parent
              {
                  IFrame^ get();
              }
  
              ///
              // Returns the URL currently loaded in this frame.
              ///
              /*--cef()--*/
              virtual property String^ Url
              {
                  String^ get();
              }
  
              ///
              // Returns the browser that this frame belongs to.
              ///
              /*--cef()--*/
              virtual property IBrowser^ Browser
              {
                  IBrowser^ get();
              }
  
              ///
              // Get the V8 context associated with the frame. This method can only be
              // called from the render process.
              ///
              /*--cef()--*/
              virtual CefRefPtr<CefV8Context> GetV8Context()
              {
                  return _frame->GetV8Context();
              }
  
              virtual IRequest^ CreateRequest(bool initializePostData);
  
              ///
              // Create a new URL request that will be treated as originating from this
              // frame and the associated browser. This request may be intercepted by the
              // client via CefResourceRequestHandler or CefSchemeHandlerFactory. Use
              // CefURLRequest::Create instead if you do not want the request to have this
              // association, in which case it may be handled differently (see documentation
              // on that method). Requests may originate from both the browser process and
              // the render process.
              //
              // For requests originating from the browser process:
              //   - POST data may only contain a single element of type PDE_TYPE_FILE or
              //     PDE_TYPE_BYTES.
              // For requests originating from the render process:
              //   - POST data may only contain a single element of type PDE_TYPE_BYTES.
              //   - If the response contains Content-Disposition or Mime-Type header values
              //     that would not normally be rendered then the response may receive
              //     special handling inside the browser (for example, via the file download
              //     code path instead of the URL request code path).
              //
              // The |request| object will be marked as read-only after calling this method.
              ///
              /*--cef()--*/
              virtual IURLRequest^ CreateURLRequest(IRequest^ request, IURLRequestClient^ client);
  
              void ThrowIfFrameInvalid();
          };
      }
  }
  