wxruby3 1.8.0 → 1.8.1

data/lib/wx/doc/gen/web/web_view_event.rb

@@ -1,210 +0,0 @@
-# :stopdoc:
-# This file is automatically generated by the WXRuby3 documentation 
-# generator. Do not alter this file.
-# :startdoc:
-
-
-module Wx
-
-  module WEB
-
-    # A navigation event holds information about events associated with {Wx::WEB::WebView} objects.
-    # 
-    # ### Events emitted by this class
-    # 
-    # The following event-handler methods redirect the events to member method or handler blocks for {Wx::WEB::WebViewEvent} events.
-    # Event handler methods for events emitted by this class:
-    # 
-    # - {Wx::EvtHandler#evt_webview_created}(id, meth = nil, &block): Process a {Wx::WEB::EVT_WEBVIEW_CREATED} event, generated when the object is fully initialized. For the backends using asynchronous initialization, such as {Wx::WebViewChromium}, most of this class member functions can be only used once this event is received. 
-    # 
-    # - {Wx::EvtHandler#evt_webview_navigating}(id, meth = nil, &block): Process a {Wx::WEB::EVT_WEBVIEW_NAVIGATING} event, generated before trying to get a resource. This event may be vetoed to prevent navigating to this resource. Note that if the displayed HTML document has several frames, one such event will be generated per frame. 
-    # 
-    # - {Wx::EvtHandler#evt_webview_navigated}(id, meth = nil, &block): Process a {Wx::WEB::EVT_WEBVIEW_NAVIGATED} event generated after it was confirmed that a resource would be requested. This event may not be vetoed. Note that if the displayed HTML document has several frames, one such event will be generated per frame. 
-    # 
-    # - {Wx::EvtHandler#evt_webview_loaded}(id, meth = nil, &block): Process a {Wx::WEB::EVT_WEBVIEW_LOADED} event generated when the document is fully loaded and displayed. Note that if the displayed HTML document has several frames, one such event will be generated per frame. 
-    # 
-    # - {Wx::EvtHandler#evt_webview_error}(id, meth = nil, &block): Process a {Wx::WEB::EVT_WEBVIEW_ERROR} event generated when a navigation error occurs. The integer associated with this event will be a {Wx::WEB::WebViewNavigationError} item. The string associated with this event may contain a backend-specific more precise error message/code. 
-    # 
-    # - {Wx::EvtHandler#evt_webview_newwindow}(id, meth = nil, &block): Process a {Wx::WEB::EVT_WEBVIEW_NEWWINDOW} event, generated when a new window is created. You must handle this event if you want anything to happen, for example to load the page in a new window or tab. For usage details see {Wx::WEB::WebViewWindowFeatures}. 
-    # 
-    # - {Wx::EvtHandler#evt_webview_newwindow_features}(id, meth = nil, &block): Process a {Wx::WEB::EVT_WEBVIEW_NEWWINDOW_FEATURES} event, generated when window features are available for the new window. For usage details see {Wx::WEB::WebViewWindowFeatures}. only available in wxWidgets 3.3.0 or later. 
-    # 
-    # - {Wx::EvtHandler#evt_webview_window_close_requested}(id, meth = nil, &block): Process a {Wx::WEB::EVT_WEBVIEW_WINDOW_CLOSE_REQUESTED} event, generated when a window is requested to be closed. only available in wxWidgets 3.3.0 or later. 
-    # 
-    # - {Wx::EvtHandler#evt_webview_title_changed}(id, meth = nil, &block): Process a {Wx::WEB::EVT_WEBVIEW_TITLE_CHANGED} event, generated when the page title changes. Use GetString to get the title. 
-    # 
-    # - {Wx::EvtHandler#evt_webview_fullscreen_changed}(id, meth = nil, &block): Process a {Wx::WEB::EVT_WEBVIEW_FULLSCREEN_CHANGED} event, generated when the page wants to enter or leave fullscreen. Use GetInt to get the status. Not implemented for the IE backend and is only available in wxWidgets 3.1.5 or later. 
-    # 
-    # - {Wx::EvtHandler#evt_webview_script_message_received}(id, meth = nil, &block): Process a {Wx::WEB::EVT_WEBVIEW_SCRIPT_MESSAGE_RECEIVED} event only available in wxWidgets 3.1.5 or later. For usage details see {Wx::WEB::WebView#add_script_message_handler}. 
-    # 
-    # - {Wx::EvtHandler#evt_webview_script_result}(id, meth = nil, &block): Process a {Wx::WEB::EVT_WEBVIEW_SCRIPT_RESULT} event only available in wxWidgets 3.1.6 or later. For usage details see {Wx::WEB::WebView#run_script_async}. 
-    # 
-    # - wxEVT_WEBVIEW_BROWSING_DATA_CLEARED(id,  func): Process a {Wx::WEB::EVT_WEBVIEW_BROWSING_DATA_CLEARED} event only available in wxWidgets 3.3.0 or later. For usage details see {Wx::WEB::WebView#clear_browsing_data}. 
-    # 
-    # Library:  {Wx::WEB::WebView}
-    # Category:  {Wx::Events}, {Wx::WEB::WebView}
-    # @see Wx::WEB::WebView 
-    # 
-    # 
-    # @wxrb_require USE_WEBVIEW
-    class WebViewEvent < NotifyEvent
-    
-      # @overload initialize()
-      #   @return [Wx::WEB::WebViewEvent]
-      # @overload initialize(type, id, href, target, flags=Wx::WEB::WebViewNavigationActionFlags::WEBVIEW_NAV_ACTION_NONE, messageHandler=(''))
-      #   @param type [Wx::TipWindow::EventType] 
-      #   @param id [Integer] 
-      #   @param href [String] 
-      #   @param target [String] 
-      #   @param flags [Wx::WebViewNavigationActionFlags] 
-      #   @param messageHandler [String] 
-      #   @return [Wx::WEB::WebViewEvent]
-      def initialize(*args) end
-      
-      # Get the name of the target frame which the url of this event has been or will be loaded into.
-      # 
-      # This may return an empty string if the frame is not available.
-      # @return [Wx::String]
-      def get_target; end
-      alias_method :target, :get_target
-      
-      # Get the URL being visited.
-      # @return [Wx::String]
-      def get_url; end
-      alias_method :url, :get_url
-      
-      # Get the type of navigation action.
-      # 
-      # Only valid for events of type {Wx::WEB::EVT_WEBVIEW_NEWWINDOW}
-      # @return [Wx::WebViewNavigationActionFlags]
-      def get_navigation_action; end
-      alias_method :navigation_action, :get_navigation_action
-      
-      # Get the name of the script handler.
-      # 
-      # Only valid for events of type {Wx::WEB::EVT_WEBVIEW_SCRIPT_MESSAGE_RECEIVED}
-      # @return [Wx::String]
-      def get_message_handler; end
-      alias_method :message_handler, :get_message_handler
-      
-      # Get information about the target window.
-      # 
-      # Only valid for events of type {Wx::WEB::EVT_WEBVIEW_NEWWINDOW_FEATURES} 
-      # 
-      # <div class="wxrb-note">
-      # <b>Note:</b>
-      # <p>This function is not implemented and always returns nil when using WebKit1 or Internet Explorer backend.
-      # </p>
-      # </div>
-      # @see Wx::WEB::WebViewWindowFeatures 
-      # @return [Wx::WEB::WebViewWindowFeatures]
-      def get_target_window_features; end
-      alias_method :target_window_features, :get_target_window_features
-      
-      # Returns true if the operation failed.
-      # 
-      # Only valid for events of type {Wx::WEB::EVT_WEBVIEW_SCRIPT_RESULT} and {Wx::WEB::EVT_WEBVIEW_BROWSING_DATA_CLEARED}
-      # @return [Boolean]
-      def is_error; end
-      alias_method :error?, :is_error
-      
-      # Returns true if the navigation target is the main frame.
-      # 
-      # Only valid for events of type {Wx::WEB::EVT_WEBVIEW_NAVIGATING} 
-      # 
-      # <div class="wxrb-note">
-      # <b>Note:</b>
-      # <p>This is only available with the macOS and the Edge backend.
-      # </p>
-      # </div>
-      # @return [Boolean]
-      def is_target_main_frame; end
-      alias_method :target_main_frame?, :is_target_main_frame
-      
-    end # WebViewEvent
-    
-    # A class describing the window information for a new child window.
-    # 
-    # An object of this class can be obtained using {Wx::WEB::WebViewEvent#get_target_window_features} while handling {Wx::WEB::EVT_WEBVIEW_NEWWINDOW_FEATURES}.
-    # If a {Wx::WEB::EVT_WEBVIEW_NEWWINDOW} is not vetoed, a {Wx::WEB::EVT_WEBVIEW_NEWWINDOW_FEATURES} event will be sent to the application. The application can then create a new window and call {Wx::WEB::WebViewEvent#get_target_window_info} to get this class providing information about the new window. A new child web view will be available via {Wx::WEB::WebViewWindowFeatures#get_child_web_view}. The application can then place the child web view into the new window by calling {Wx::WEB::WebView#create} on the child web view.
-    # Sample JavaScript opening a new window: 
-    # ```
-    #   window.open("https://www.wxwidgets.org", "newWindow", "width=400,height=400");
-    # ```
-    # 
-    # Sample code handling a new window request: 
-    # 
-    # ```ruby
-    #   # Bind new window handler
-    #   @webView.evt_webview_newwindow(Wx::ID_ANY) { |evt|
-    #     if evt.get_url == "http://badwebsite.com"
-    #       evt.veto # Disallow new window for badwebsite.com
-    #     else
-    #       evt.skip # Allow new window for all other websites
-    #     end    
-    #   }
-    #   
-    #   # Bind new window features handler
-    #   @webView.evt_webview_newwindow_features(Wx::ID_ANY) { |evt|
-    #      # Get target window features
-    #      features = evt.get_target_window_features
-    #      # Create a top level window for the child web view
-    #      win = Wx::Frame.new(nil, Wx::ID_ANY, features.get_position, features.get_size)
-    #      sizer = Wx::VBoxSizer.new
-    #      win.set_sizer(sizer)
-    #      # Get the child web view
-    #      childWebView = features.get_child_web_view
-    #      # Place the child web view into the window
-    #      childWebView.create(win, Wx::ID_ANY)
-    #      sizer.add(childWebView, Wx::SizerFlags.new.proportion(1).expand)
-    #   }
-    # ```
-    # 
-    # 
-    # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
-    # @wxrb_require USE_WEBVIEW
-    class WebViewWindowFeatures < ::Object
-    
-      # Get the child web view for the target window.
-      # 
-      # This is available in the event handler for {Wx::WEB::EVT_WEBVIEW_NEWWINDOW_FEATURES} and {Wx::WEB::WebView#create} <b>must</b> be called on the child web view directly.
-      # The requested URL will be loaded automatically in the child web view.
-      # @return [Wx::WEB::WebView]
-      def get_child_web_view; end
-      alias_method :child_web_view, :get_child_web_view
-      
-      # Returns the position of the new window if specified by a <code>window.open()</code> call.
-      # @return [Wx::Point]
-      def get_position; end
-      alias_method :position, :get_position
-      
-      # Returns the size of the new window if specified by a <code>window.open()</code> call.
-      # @return [Wx::Size]
-      def get_size; end
-      alias_method :size, :get_size
-      
-      # Returns true if the target window is expected to display a menu bar as specified by a <code>window.open()</code> call.
-      # @return [Boolean]
-      def should_display_menu_bar; end
-      
-      # Returns true if the target window is expected to display a status bar as specified by a <code>window.open()</code> call.
-      # @return [Boolean]
-      def should_display_status_bar; end
-      
-      # Returns true if the target window is expected to display a tool bar as specified by a <code>window.open()</code> call.
-      # @return [Boolean]
-      def should_display_tool_bar; end
-      
-      # Returns true if the target window is expected to display scroll bars as specified by a <code>window.open()</code> call.
-      # @return [Boolean]
-      def should_display_scroll_bars; end
-      
-      
-      protected
-      
-    end # WebViewWindowFeatures
-    
-
-  end
-
-end

data/lib/wx/doc/gen/web/web_view_handler.rb

@@ -1,318 +0,0 @@
-# :stopdoc:
-# This file is automatically generated by the WXRuby3 documentation 
-# generator. Do not alter this file.
-# :startdoc:
-
-
-module Wx
-
-  module WEB
-
-    # The base class for handling custom schemes in {Wx::WEB::WebView}, for example to allow virtual file system support.
-    # 
-    # A new handler should either implement {Wx::WEB::WebViewHandler#get_file} or if a more detailed request handling is required (access to headers, post data) {Wx::WEB::WebViewHandler#start_request} has to be implemented.
-    # 
-    # Category:  {Wx::WEB::WebView}
-    # @see Wx::WEB::WebView 
-    # 
-    # 
-    # 
-    # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
-    # @wxrb_require USE_WEBVIEW
-    class WebViewHandler < ::Object
-    
-      # Constructor.
-      # 
-      # Takes the name of the scheme that will be handled by this class for example file or zip.
-      # @param scheme [String] 
-      # @return [Wx::WEB::WebViewHandler]
-      def initialize(scheme) end
-      
-      # 
-      # 
-      # A pointer to the file represented by uri.
-      # @param uri [String] 
-      # @return [Wx::FSFile]
-      def get_file(uri) end
-      alias_method :file, :get_file
-      
-      # 
-      # 
-      # The name of the scheme, as passed to the constructor.
-      # @return [String]
-      def get_name; end
-      alias_method :name, :get_name
-      
-      # Sets a custom security URL.
-      # 
-      # Only used by {Wx::WebViewIE}.
-      # @param url [String] 
-      # @return [void]
-      def set_security_url(url) end
-      alias_method :security_url=, :set_security_url
-      
-      # 
-      # 
-      # The custom security URL. Only used by {Wx::WebViewIE}.
-      # @return [String]
-      def get_security_url; end
-      alias_method :security_url, :get_security_url
-      
-      # When using the edge backend handler urls are https urls with a virtual host.
-      # 
-      # As default <code>name.wxsite</code> is used as the virtual hostname. If you customize this host, use a non existing site (ideally a reserved subdomain of a domain you control). If localassests.domain.example is used the handlers content will be available under https://localassets.domain.example/
-      # This has to be set <b>before</b> registering the handler via {Wx::WEB::WebView#register_handler}.
-      # @param host [String] 
-      # @return [void]
-      def set_virtual_host(host) end
-      alias_method :virtual_host=, :set_virtual_host
-      
-      # 
-      # 
-      # The virtual host of this handler
-      # @see Wx::WEB::WebViewHandler#set_virtual_host 
-      # @return [String]
-      def get_virtual_host; end
-      alias_method :virtual_host, :get_virtual_host
-      
-      # Implementing this method allows for more control over requests from the backend than {Wx::WEB::WebViewHandler#get_file}.
-      # 
-      # More details of the request are available from the request object which allows access to URL, method, postdata and headers.
-      # A response can be send via the response object. The response does not have to be finished from this method and it's possible to be finished asynchronously via {Wx::WEB::WebViewHandlerResponse#finish}.
-      # The following pseudo code demonstrates a typical implementation: 
-      # ```ruby
-      # def start_request(request, response)
-      #    # Set common headers allowing access from XMLHTTPRequests()
-      #    response.set_header("Access-Control-Allow-Origin", "*")
-      #    response.set_header("Access-Control-Allow-Headers", "*")
-      # 
-      #    # Handle options request
-      #    if request.get_method.casecmp("options") == 0
-      #      response.finish("")
-      #      return
-      #    end
-      # 
-      #    # Check the post data type
-      #    unless request.get_header("Content-Type").start_with?("application/json")
-      #      response.finish_with_error
-      #      return;
-      #    end
-      # 
-      #    # Process input data
-      #    postData = request.get_data_string
-      # 
-      #    #...
-      # 
-      #    # Send result
-      #    response.set_content_type("application/json")
-      #    response.finish("{ result: true }")
-      # end
-      # ```
-      # 
-      # <div class="wxrb-note">
-      # <b>Note:</b>
-      # <p>This is only used by macOS, Chromium, and the Edge backend.
-      # </p>
-      # </div>
-      # @see Wx::WEB::WebViewHandler#get_file 
-      # @param request [Wx::WEB::WebViewHandlerRequest] 
-      # @param response [Wx::WEB::WebViewHandlerResponse] 
-      # @return [void]
-      def start_request(request, response) end
-      
-    end # WebViewHandler
-    
-    # A custom handler for the file scheme which also supports loading from archives.
-    # 
-    # The syntax for {Wx::WEB::WebViewArchiveHandler} differs from virtual file systems in the rest of wxWidgets by using a syntax such as <code> scheme:///C:/example/docs.zip;protocol=zip/main.htm </code> Currently the only supported protocol is zip.
-    # 
-    # Category:  {Wx::WEB::WebView}
-    # @see Wx::WEB::WebView
-    # @see  Wx::WEB::WebViewHandler 
-    # 
-    # 
-    # 
-    # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
-    # @wxrb_require USE_WEBVIEW
-    class WebViewArchiveHandler < WebViewHandler
-    
-      # Constructor.
-      # @param scheme [String] 
-      # @return [Wx::WEB::WebViewArchiveHandler]
-      def initialize(scheme) end
-      
-      # 
-      # 
-      # A pointer to the file represented by uri.
-      # @param uri [String] 
-      # @return [Wx::FSFile]
-      def get_file(uri) end
-      alias_method :file, :get_file
-      
-    end # WebViewArchiveHandler
-    
-    # A {Wx::WEB::WebView} file system handler to support standard {Wx::FileSystem} protocols of the form <code> example:page.htm </code> The handler allows {Wx::WEB::WebView} to use {Wx::FileSystem} in a similar fashion to its use with {Wx::HTML}.
-    # 
-    # The {Wx::MemoryFSHandler} documentation gives an example of how it may be used.
-    # 
-    # Category:  {Wx::WEB::WebView}
-    # @see Wx::WEB::WebView
-    # @see  Wx::WEB::WebViewHandler
-    # @see  Wx::WEB::WebViewArchiveHandler 
-    # 
-    # 
-    # 
-    # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
-    # @wxrb_require USE_WEBVIEW
-    class WebViewFSHandler < WebViewHandler
-    
-      # Constructor.
-      # @param scheme [String] 
-      # @return [Wx::WEB::WebViewFSHandler]
-      def initialize(scheme) end
-      
-      # 
-      # 
-      # A pointer to the file represented by uri.
-      # @param uri [String] 
-      # @return [Wx::FSFile]
-      def get_file(uri) end
-      alias_method :file, :get_file
-      
-    end # WebViewFSHandler
-    
-    # A class giving access to various parameters of a webview request.
-    # 
-    # Category:  {Wx::WEB::WebView}
-    # @see Wx::WEB::WebViewHandler#start_request 
-    # 
-    # 
-    # 
-    # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
-    # @wxrb_require USE_WEBVIEW
-    class WebViewHandlerRequest < ::Object
-    
-      # 
-      # 
-      # The unmodified url of the request.
-      # @return [String]
-      def get_raw_uri; end
-      alias_method :raw_uri, :get_raw_uri
-      
-      # 
-      # 
-      # The url of the request. Can be modified by the backend for compatibility.
-      # @return [String]
-      def get_uri; end
-      alias_method :uri, :get_uri
-      
-      # 
-      # 
-      # The body data of the request of null if nothing was posted.
-      # @return [Wx::InputStream]
-      def get_data; end
-      alias_method :data, :get_data
-      
-      # 
-      # 
-      # The body data of the request as a string. The returned string is empty if the supplied conv doesn't match the encoding.
-      # @param conv [Wx::MBConv] 
-      # @return [String]
-      def get_data_string(conv=wxConvUTF8) end
-      alias_method :data_string, :get_data_string
-      
-      # 
-      # 
-      # The requests HTTP method (e.g. POST, GET, OPTIONS).
-      # @return [String]
-      def get_method; end
-      alias_method :method, :get_method
-      
-      # Returns a header from the request or an empty string if the header could not be found.
-      # @param name [String]  Name of the header field
-      # @return [String]
-      def get_header(name) end
-      alias_method :header, :get_header
-      
-    end # WebViewHandlerRequest
-    
-    # A class giving access to various webview response parameters.
-    # 
-    # Usually a {web_view_handler} would set various parameters required for the response like HTTP status, various headers and must then call {Wx::WEB::WebViewHandlerResponse#finish} to complete the response or call {Wx::WEB::WebViewHandlerResponse#finish_with_error} to abort the request.
-    # 
-    # Category:  {Wx::WEB::WebView}
-    # @see Wx::WEB::WebViewHandler#start_request 
-    # 
-    # 
-    # 
-    # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
-    # @wxrb_require USE_WEBVIEW
-    class WebViewHandlerResponse < ::Object
-    
-      # Sets the status code of the response.
-      # @param status [Integer]  HTTP status code
-      # @return [void]
-      def set_status(status) end
-      alias_method :status=, :set_status
-      
-      # Sets the MIME type of the response.
-      # @param contentType [String]  MIME type of the response content
-      # @return [void]
-      def set_content_type(contentType) end
-      alias_method :content_type=, :set_content_type
-      
-      # Sets a response header which will be sent to the web view.
-      # 
-      # The header will be added if it hasn't been set before or replaced otherwise.
-      # @param name [String]  Name of the header
-      # @param value [String]  String value of the header
-      # @return [void]
-      def set_header(name, value) end
-      
-      # @overload finish(data)
-      #   Finishes the request with binary data.
-      #   
-      #   @see finish(text, conv)
-      #   @param data [Wx::WEB::WebViewHandlerResponseData]  The data object will be dereferenced when the request is completed
-      #   @return [void]
-      # @overload finish(text, conv=wxConvUTF8)
-      #   Finishes the request with text data.
-      #   
-      #   @see find(data)
-      #   @param text [String]  Text content of the response (can be empty)
-      #   @param conv [Wx::MBConv]  Conversion used when sending the text in the response
-      #   @return [void]
-      def finish(*args) end
-      
-      # Finishes the request as an error.
-      # 
-      # This will notify that the request could not produce any data.
-      # @see Wx::WEB::WebViewHandlerResponse#finish 
-      # @return [void]
-      def finish_with_error; end
-      
-    end # WebViewHandlerResponse
-    
-    # A class holding the response data.
-    # 
-    # @see Wx::WEB::WebViewHandlerResponse#finish(data)
-    # 
-    # 
-    # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
-    # @wxrb_require USE_WEBVIEW
-    class WebViewHandlerResponseData < ::Object
-    
-      # 
-      # 
-      # A pointer to the stream.
-      # @see Wx::WEB::WebViewHandlerResponse#finish 
-      # @return [Wx::InputStream]
-      def get_stream; end
-      alias_method :stream, :get_stream
-      
-    end # WebViewHandlerResponseData
-    
-
-  end
-
-end