# :stopdoc:
# This file is automatically generated by the WXRuby3 documentation 
# generator. Do not alter this file.
# :startdoc:


module Wx::RTC

  # Handles HTML output (only) for {Wx::RTC::RichTextCtrl} content.
  # The most flexible way to use this class is to create a temporary object and call its functions directly, rather than use {Wx::RTC::RichTextBuffer#save_file} or {Wx::RTC::RichTextCtrl#save_file}.
  # Image handling requires a little extra work from the application, to choose an appropriate image format for the target HTML viewer and to clean up the temporary images later. If you are planning to load the HTML into a standard web browser, you can specify the handler flag {Wx::RTC::RICHTEXT_HANDLER_SAVE_IMAGES_TO_BASE64} (the default) and no extra work is required: the images will be written with the HTML.
  # However, if you want {Wx::HTML} compatibility, you will need to use {Wx::RTC::RICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY} or {Wx::RTC::RICHTEXT_HANDLER_SAVE_IMAGES_TO_FILES}.
  # In this case, you must either call {Wx::RTC::RichTextHTMLHandler#delete_temporary_images} before the next load operation, or you must store the image locations and delete them yourself when appropriate.
  # You can call {Wx::RTC::RichTextHTMLHandler#get_temporary_image_locations} to get the array of temporary image names.
  # 
  # == Handler flags
  # 
  # The following flags can be used with this handler, via the handler's {Wx::RTC::RichTextHTMLHandler#set_flags} function or the buffer or control's SetHandlerFlags() function:
  # 
  # - {Wx::RTC::RICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY} Images are saved to the memory filesystem: suitable for showing {Wx::HTML} windows.
  # - {Wx::RTC::RICHTEXT_HANDLER_SAVE_IMAGES_TO_FILES} Images are saved to temporary files: suitable for showing in {Wx::HTML} windows.
  # - {Wx::RTC::RICHTEXT_HANDLER_SAVE_IMAGES_TO_BASE64} Images are written with the HTML files in Base 64 format: suitable for showing in web browsers.
  # - {Wx::RTC::RICHTEXT_HANDLER_NO_HEADER_FOOTER} Don't include header and footer tags (HTML, HEAD, BODY), so that the HTML can be used as part of a larger document.
  # - {Wx::RTC::RICHTEXT_HANDLER_USE_CSS} Use CSS where possible, otherwise use workarounds that will show in {Wx::HTML::HtmlWindow}.
  # 
  # === 
  # 
  # Category:  Rich Text
  # 
  class RichTextHTMLHandler < RichTextFileHandler
  
    # Constructor.
    # @param name [String] 
    # @param ext [String] 
    # @param type [Integer] 
    # @return [Wx::RTC::RichTextHTMLHandler]
    def initialize(name=("Wx::HTML"), ext=("Wx::HTML"), type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_HTML) end
    
    # Clears the image locations generated by the last operation.
    # @return [void]
    def clear_temporary_image_locations; end
    
    # Delete the in-memory or temporary files generated by the last operation.
    # This is a static function that can be used to delete the saved locations from an earlier operation, for example after the user has viewed the HTML file.
    # @param flags [Integer] 
    # @param imageLocations [Array<String>] 
    # @return [Boolean]
    def self.delete_temporary_images(flags, imageLocations) end
    
    # Returns the mapping for converting point sizes to HTML font sizes.
    # @return [Array<Integer>]
    def get_font_size_mapping; end
    alias_method :font_size_mapping, :get_font_size_mapping
    
    # Returns the directory used to store temporary image files.
    # @return [Wx::String]
    def get_temp_dir; end
    alias_method :temp_dir, :get_temp_dir
    
    # Returns the image locations for the last operation.
    # @return [Wx::ArrayString]
    def get_temporary_image_locations; end
    alias_method :temporary_image_locations, :get_temporary_image_locations
    
    # Sets the mapping for converting point sizes to HTML font sizes.
    # There should be 7 elements, one for each HTML font size, each element specifying the maximum point size for that HTML font size. For example: 
    # ```ruby
    #   html_handler.set_font_size_mapping([7,9,11,12,14,22,100])
    # ```
    # @param fontSizeMapping [Array<Integer>] 
    # @return [void]
    def set_font_size_mapping(fontSizeMapping) end
    alias_method :font_size_mapping=, :set_font_size_mapping
    
    # Sets the directory for storing temporary files.
    # If empty, the system temporary directory will be used.
    # @param tempDir [String] 
    # @return [void]
    def set_temp_dir(tempDir) end
    alias_method :temp_dir=, :set_temp_dir
    
    # Sets the list of image locations generated by the last operation.
    # @param locations [Array<String>] 
    # @return [void]
    def set_temporary_image_locations(locations) end
    alias_method :temporary_image_locations=, :set_temporary_image_locations
    
    # Reset the file counter, in case, for example, the same names are required each time.
    # @param counter [Integer] 
    # @return [void]
    def self.set_file_counter(counter) end
    
  end # RichTextHTMLHandler
  

end