WebView.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/WebView.h - Released 2024-06-18T15:48:54Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All 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.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS 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 PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) 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.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_WebView_h
#define __PCL_WebView_h
 
 
#include <pcl/Defs.h>
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/AutoPointer.h>
#include <pcl/Color.h>
#include <pcl/Control.h>
#include <pcl/Variant.h>
 
#endif   // !__PCL_BUILDING_PIXINSIGHT_APPLICATION
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS WebView : public Control
{
public:
 
   WebView( Control& parent = Control::Null() );
 
   ~WebView() override
   {
   }
 
   void SetContent( const ByteArray& data, const IsoString& mimeType = IsoString() );
 
   void SetHTML( const IsoString& html );
 
   void SetHTML( const String& html );
 
   void SetPlainText( const IsoString& text );
 
   void SetPlainText( const String& text );
 
   void LoadContent( const String& uri );
 
   void RequestPlainText() const;
 
   void RequestHTML() const;
 
   void SaveAsPDF( const String& filePath, double pageWidth = 210, double pageHeight = 297,
                   double marginLeft = 10, double marginTop = 10, double marginRight = 10, double marginBottom = 10,
                   bool landscape = false );
 
   bool HasSelection() const;
 
   String SelectedText() const;
 
   double ZoomFactor() const;
 
   void SetZoomFactor( double zoom );
 
   RGBA BackgroundColor() const;
 
   void SetBackgroundColor( RGBA color );
 
   void Reload();
 
   void Stop();
 
   void EvaluateScript( const String& sourceCode, const IsoString& language = IsoString() );
 
   using view_event_handler = void (Control::*)( WebView& sender );
 
   using progress_event_handler = void (Control::*)( WebView& sender, int loadPercent );
 
   using state_event_handler = void (Control::*)( WebView& sender, bool state );
 
   using content_event_handler = void (Control::*)( WebView& sender, const String& content );
 
   using result_event_handler = void (Control::*)( WebView& sender, const Variant& result );
 
   void OnLoadStarted( view_event_handler handler, Control& receiver );
 
   void OnLoadProgress( progress_event_handler handler, Control& receiver );
 
   void OnLoadFinished( state_event_handler handler, Control& receiver );
 
   void OnSelectionUpdated( view_event_handler handler, Control& receiver );
 
   void OnPlainTextAvailable( content_event_handler handler, Control& receiver );
 
   void OnHTMLAvailable( content_event_handler handler, Control& receiver );
 
   void OnScriptResultAvailable( result_event_handler handler, Control& receiver );
 
private:
 
   struct EventHandlers
   {
      view_event_handler     onLoadStarted = nullptr;
      progress_event_handler onLoadProgress = nullptr;
      state_event_handler    onLoadFinished = nullptr;
      view_event_handler     onSelectionUpdated = nullptr;
      content_event_handler  onPlainTextAvailable = nullptr;
      content_event_handler  onHTMLAvailable = nullptr;
      result_event_handler   onScriptResultAvailable = nullptr;
 
      EventHandlers() = default;
      EventHandlers( const EventHandlers& ) = default;
      EventHandlers& operator =( const EventHandlers& ) = default;
   };
 
   AutoPointer<EventHandlers> m_handlers;
 
   friend class WebViewEventDispatcher;
};
 
// ----------------------------------------------------------------------------
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
} // pcl
 
#endif   // __PCL_WebView_h
 
// ----------------------------------------------------------------------------
// EOF pcl/WebView.h - Released 2024-06-18T15:48:54Z