wxruby3 0.9.0.pre.beta.2-x64-mingw-ucrt-3.2-3.2.2

data/lib/wx/doc/gen/rtc/rich_text_printing.rb

@@ -0,0 +1,241 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx::RTC
+
+  # This class provides a simple interface for performing {Wx::RTC::RichTextBuffer} printing and previewing.
+  # It uses {Wx::RTC::RichTextPrintout} for layout and rendering.
+  # === 
+  # 
+  # Category:  Rich Text
+  # 
+  class RichTextPrinting < Object
+  
+    # Constructor.
+    # Optionally pass a title to be used in the preview frame and printing wait dialog, and also a parent window for these windows.
+    # @param name [String] 
+    # @param parentWindow [Wx::Window] 
+    # @return [RichTextPrinting]
+    def initialize(name=("Wx::PRINTING"), parentWindow=nil) end
+    
+    # A convenience function to get the footer text.
+    # See {Wx::RTC::RichTextHeaderFooterData} for details.
+    # @param page [RichTextOddEvenPage] 
+    # @param location [RichTextPageLocation] 
+    # @return [String]
+    def get_footer_text(page=Wx::RICHTEXT_PAGE_EVEN, location=Wx::RICHTEXT_PAGE_CENTRE) end
+    alias_method :footer_text, :get_footer_text
+    
+    # Returns the internal {Wx::RTC::RichTextHeaderFooterData} object.
+    # @return [Wx::RichTextHeaderFooterData]
+    def get_header_footer_data; end
+    alias_method :header_footer_data, :get_header_footer_data
+    
+    # A convenience function to get the header text.
+    # See {Wx::RTC::RichTextHeaderFooterData} for details.
+    # @param page [RichTextOddEvenPage] 
+    # @param location [RichTextPageLocation] 
+    # @return [String]
+    def get_header_text(page=Wx::RICHTEXT_PAGE_EVEN, location=Wx::RICHTEXT_PAGE_CENTRE) end
+    alias_method :header_text, :get_header_text
+    
+    # Returns the parent window to be used for the preview window and printing wait dialog.
+    # @return [Wx::Window]
+    def get_parent_window; end
+    alias_method :parent_window, :get_parent_window
+    
+    # Returns the dimensions to be used for the preview window.
+    # @return [Wx::Rect]
+    def get_preview_rect; end
+    alias_method :preview_rect, :get_preview_rect
+    
+    # Returns the title of the preview window or printing wait caption.
+    # @return [Wx::String]
+    def get_title; end
+    alias_method :title, :get_title
+    
+    # Shows the page setup dialog.
+    # @return [void]
+    def page_setup; end
+    
+    # Shows a preview window for the given buffer.
+    # The function takes its own copy of buffer.
+    # @param buffer [Wx::RichTextBuffer] 
+    # @return [true,false]
+    def preview_buffer(buffer) end
+    
+    # Shows a preview window for the given file.
+    # richTextFile can be a text file or XML file, or other file depending on the available file handlers.
+    # @param richTextFile [String] 
+    # @return [true,false]
+    def preview_file(richTextFile) end
+    
+    # Prints the given buffer.
+    # The function takes its own copy of buffer. showPrintDialog can be true to show the print dialog, or false to print quietly.
+    # @param buffer [Wx::RichTextBuffer] 
+    # @param showPrintDialog [true,false] 
+    # @return [true,false]
+    def print_buffer(buffer, showPrintDialog=true) end
+    
+    # Prints the given file.
+    # richTextFile can be a text file or XML file, or other file depending on the available file handlers. showPrintDialog can be true to show the print dialog, or false to print quietly.
+    # @param richTextFile [String] 
+    # @param showPrintDialog [true,false] 
+    # @return [true,false]
+    def print_file(richTextFile, showPrintDialog=true) end
+    
+    # A convenience function to set the footer text.
+    # See {Wx::RTC::RichTextHeaderFooterData} for details.
+    # @param text [String] 
+    # @param page [RichTextOddEvenPage] 
+    # @param location [RichTextPageLocation] 
+    # @return [void]
+    def set_footer_text(text, page=Wx::RICHTEXT_PAGE_ALL, location=Wx::RICHTEXT_PAGE_CENTRE) end
+    alias_method :footer_text=, :set_footer_text
+    
+    # Sets the internal {Wx::RTC::RichTextHeaderFooterData} object.
+    # @param data [Wx::RichTextHeaderFooterData] 
+    # @return [void]
+    def set_header_footer_data(data) end
+    alias_method :header_footer_data=, :set_header_footer_data
+    
+    # Sets the {Wx::RTC::RichTextHeaderFooterData} font.
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_header_footer_font(font) end
+    alias_method :header_footer_font=, :set_header_footer_font
+    
+    # Sets the {Wx::RTC::RichTextHeaderFooterData} text colour.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_header_footer_text_colour(colour) end
+    alias_method :header_footer_text_colour=, :set_header_footer_text_colour
+    
+    # A convenience function to set the header text.
+    # See {Wx::RTC::RichTextHeaderFooterData} for details.
+    # @param text [String] 
+    # @param page [RichTextOddEvenPage] 
+    # @param location [RichTextPageLocation] 
+    # @return [void]
+    def set_header_text(text, page=Wx::RICHTEXT_PAGE_ALL, location=Wx::RICHTEXT_PAGE_CENTRE) end
+    alias_method :header_text=, :set_header_text
+    
+    # Sets the page setup data.
+    # @param pageSetupData [Wx::PageSetupDialogData] 
+    # @return [void]
+    def set_page_setup_data(pageSetupData) end
+    alias_method :page_setup_data=, :set_page_setup_data
+    
+    # Sets the parent window to be used for the preview window and printing wait dialog.
+    # @param parent [Wx::Window] 
+    # @return [void]
+    def set_parent_window(parent) end
+    alias_method :parent_window=, :set_parent_window
+    
+    # Sets the dimensions to be used for the preview window.
+    # @param rect [Wx::Rect] 
+    # @return [void]
+    def set_preview_rect(rect) end
+    alias_method :preview_rect=, :set_preview_rect
+    
+    # Sets the print data.
+    # @param printData [Wx::PrintData] 
+    # @return [void]
+    def set_print_data(printData) end
+    alias_method :print_data=, :set_print_data
+    
+    # Pass true to show the header and footer on the first page.
+    # @param show [true,false] 
+    # @return [void]
+    def set_show_on_first_page(show) end
+    alias_method :show_on_first_page=, :set_show_on_first_page
+    
+    # Pass the title of the preview window or printing wait caption.
+    # @param title [String] 
+    # @return [void]
+    def set_title(title) end
+    alias_method :title=, :set_title
+    
+  end # RichTextPrinting
+  
+  # This class implements print layout for {Wx::RTC::RichTextBuffer}.
+  # Instead of using it directly, you should normally use the {Wx::RTC::RichTextPrinting} class.
+  # === 
+  # 
+  # Category:  Rich Text
+  # 
+  class RichTextPrintout < Printout
+  
+    # Constructor.
+    # @param title [String] 
+    # @return [RichTextPrintout]
+    def initialize(title=("Wx::PRINTOUT")) end
+    
+    # Calculates scaling and text, header and footer rectangles.
+    # @param dc [Wx::DC] 
+    # @param textRect [Wx::Rect] 
+    # @param headerRect [Wx::Rect] 
+    # @param footerRect [Wx::Rect] 
+    # @return [void]
+    def calculate_scaling(dc, textRect, headerRect, footerRect) end
+    
+    # Returns the header and footer data associated with the printout.
+    # @return [Wx::RichTextHeaderFooterData]
+    def get_header_footer_data; end
+    alias_method :header_footer_data, :get_header_footer_data
+    
+    # Gets the page information.
+    # @return [Array(Integer,Integer,Integer,Integer)]
+    def get_page_info; end
+    alias_method :page_info, :get_page_info
+    
+    # Returns a pointer to the buffer being rendered.
+    # @return [Wx::RichTextBuffer]
+    def get_rich_text_buffer; end
+    alias_method :rich_text_buffer, :get_rich_text_buffer
+    
+    # Returns true if the given page exists in the printout.
+    # @param page [Integer] 
+    # @return [true,false]
+    def has_page(page) end
+    alias_method :has_page?, :has_page
+    
+    # Prepares for printing, laying out the buffer and calculating pagination.
+    # @return [void]
+    def on_prepare_printing; end
+    
+    # Does the actual printing for this page.
+    # @param page [Integer] 
+    # @return [true,false]
+    def on_print_page(page) end
+    
+    # Sets the header and footer data associated with the printout.
+    # @param data [Wx::RichTextHeaderFooterData] 
+    # @return [void]
+    def set_header_footer_data(data) end
+    alias_method :header_footer_data=, :set_header_footer_data
+    
+    # Sets margins in 10ths of millimetre.
+    # Defaults to 1 inch for margins.
+    # @param top [Integer] 
+    # @param bottom [Integer] 
+    # @param left [Integer] 
+    # @param right [Integer] 
+    # @return [void]
+    def set_margins(top=254, bottom=254, left=254, right=254) end
+    alias_method :margins=, :set_margins
+    
+    # Sets the buffer to print.
+    # {Wx::RTC::RichTextPrintout} does not manage this pointer; it should be managed by the calling code, such as {Wx::RTC::RichTextPrinting}.
+    # @param buffer [Wx::RichTextBuffer] 
+    # @return [void]
+    def set_rich_text_buffer(buffer) end
+    alias_method :rich_text_buffer=, :set_rich_text_buffer
+    
+  end # RichTextPrintout
+  
+
+end

data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb

@@ -0,0 +1,55 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx::RTC
+
+  # A handler for loading and saving content in an XML format specific to {Wx::RTC::RichTextBuffer}.
+  # You can either add the handler to the buffer and load and save through the buffer or control API, or you can create an instance of the handler on the stack and call its functions directly.
+  # 
+  # == Handler flags
+  # 
+  # The following flags can be used with this handler, via the handler's {Wx::RTC::RichTextXMLHandler#set_flags} function or the buffer or control's SetHandlerFlags() function:
+  # 
+  # - {Wx::RTC::RICHTEXT_HANDLER_INCLUDE_STYLESHEET} Include the style sheet in loading and saving operations.
+  # 
+  # === 
+  # 
+  # Category:  Rich Text
+  # 
+  class RichTextXMLHandler < RichTextFileHandler
+  
+    # Constructor.
+    # @param name [String] 
+    # @param ext [String] 
+    # @param type [Integer] 
+    # @return [RichTextXMLHandler]
+    def initialize(name=("Wx::XML"), ext=("Wx::XML"), type=Wx::RICHTEXT_TYPE_XML) end
+    
+    # Returns true.
+    # @return [true,false]
+    def can_load; end
+    alias_method :can_load?, :can_load
+    
+    # Returns true.
+    # @return [true,false]
+    def can_save; end
+    alias_method :can_save?, :can_save
+    
+    # Call with XML node name, C++ class name so that {Wx::RTC} can read in the node.
+    # If you add a custom object, call this.
+    # @param nodeName [String] 
+    # @param className [String] 
+    # @return [void]
+    def self.register_node_name(nodeName, className) end
+    
+    # Cleans up the mapping between node name and C++ class.
+    # @return [void]
+    def self.clear_node_to_class_map; end
+    
+  end # RichTextXMLHandler
+  
+
+end

data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb

@@ -0,0 +1,153 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx::RTC
+
+  # {Wx::RTC::SymbolPickerDialog} presents the user with a choice of fonts and a grid of available characters.
+  # This modal dialog provides the application with a selected symbol and optional font selection.
+  # Although this dialog is contained in the rich text library, the dialog is generic and can be used in other contexts.
+  # To use the dialog, pass a default symbol specified as a string, an initial font name, and a current font name. The difference between the initial font and current font is that the initial font determines what the font control will be set to when the dialog shows - an empty string will show the selection normal text. The current font, on the other hand, is used by the dialog to determine what font to display the characters in, even when no initial font is selected. This allows the user (and application) to distinguish between inserting a symbol in the current font, and inserting it with a specified font.
+  # When the dialog is dismissed, the application can get the selected symbol with {Wx::RTC::SymbolPickerDialog#get_symbol} and test whether a font was specified with {Wx::RTC::SymbolPickerDialog#use_normal_font},fetching the specified font with {Wx::RTC::SymbolPickerDialog#get_font_name}.
+  # Here's a realistic example, inserting the supplied symbol into a rich text control in either the current font or specified font.
+  # 
+  #   wxRichTextCtrl* ctrl = (wxRichTextCtrl*) FindWindow(ID_RICHTEXT_CTRL);
+  #   
+  #   wxTextAttr attr;
+  #   attr.SetFlags(wxTEXT_ATTR_FONT);
+  #   ctrl-GetStyle(ctrl->GetInsertionPoint(), attr);
+  #   
+  #   wxString currentFontName;
+  #   if (attr.HasFont() && attr.GetFont().IsOk())
+  #       currentFontName = attr.GetFont().GetFaceName();
+  #   
+  #   // Don't set the initial font in the dialog (so the user is choosing
+  #   // 'normal text', i.e. the current font) but do tell the dialog
+  #   // what 'normal text' is.
+  #   
+  #   wxSymbolPickerDialog dlg("*", wxEmptyString, currentFontName, this);
+  #   
+  #   if (dlg.ShowModal() == wxID_OK)
+  #   {
+  #       if (dlg.HasSelection())
+  #       {
+  #           long insertionPoint = ctrl-GetInsertionPoint();
+  #   
+  #           ctrl->WriteText(dlg.GetSymbol());
+  #   
+  #           if (!dlg.UseNormalFont())
+  #           {
+  #               wxFont font(attr.GetFont());
+  #               font.SetFaceName(dlg.GetFontName());
+  #               attr.SetFont(font);
+  #               ctrl-SetStyle(insertionPoint, insertionPoint+1, attr);
+  #           }
+  #       }
+  #   }
+  # 
+  # === 
+  # 
+  # Category:  Common Dialogs
+  # 
+  class SymbolPickerDialog < Dialog
+  
+    # @overload initialize()
+    #   Default ctor.
+    #   @return [SymbolPickerDialog]
+    # @overload initialize(symbol, initialFont, normalTextFont, parent, id=Wx::ID_ANY, title=(_.new("Wx::SYMBOLS")), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::DEFAULT_DIALOG_STYLE|Wx::RESIZE_BORDER|Wx::CLOSE_BOX))
+    #   Constructor.
+    #   @param symbol [String]  The initial symbol to show. Specify a single character in a string, or an empty string.
+    #   @param initialFont [String]  The initial font to be displayed in the font list. If empty, the item normal text will be selected.
+    #   @param normalTextFont [String]  The font the dialog will use to display the symbols if the initial font is empty.
+    #   @param parent [Wx::Window]  The dialog's parent.
+    #   @param id [Integer]  The dialog's identifier.
+    #   @param title [String]  The dialog's caption.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  The dialog's position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  The dialog's size.
+    #   @param style [Integer]  The dialog's window style.
+    #   @return [SymbolPickerDialog]
+    def initialize(*args) end
+    
+    # Creation: see the constructor for details about the parameters.
+    # @param symbol [String] 
+    # @param initialFont [String] 
+    # @param normalTextFont [String] 
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param caption [String] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @return [true,false]
+    def create(symbol, initialFont, normalTextFont, parent, id=Wx::ID_ANY, caption=(Wx::GetTranslation.new("Wx::SYMBOLS")), pos=Wx::DEFAULT_POSITION, size=(Wx::Size.new(400, 300)), style=(Wx::DEFAULT_DIALOG_STYLE|Wx::RESIZE_BORDER|Wx::CLOSE_BOX)) end
+    
+    # Returns the font name (the font reflected in the font list).
+    # @return [String]
+    def get_font_name; end
+    alias_method :font_name, :get_font_name
+    
+    # Returns true if the dialog is showing the full range of Unicode characters.
+    # @return [true,false]
+    def get_from_unicode; end
+    alias_method :from_unicode, :get_from_unicode
+    
+    # Gets the font name used for displaying symbols in the absence of a selected font.
+    # @return [String]
+    def get_normal_text_font_name; end
+    alias_method :normal_text_font_name, :get_normal_text_font_name
+    
+    # Gets the current or initial symbol as a string.
+    # @return [String]
+    def get_symbol; end
+    alias_method :symbol, :get_symbol
+    
+    # Gets the selected symbol character as an integer.
+    # @return [Integer]
+    def get_symbol_char; end
+    alias_method :symbol_char, :get_symbol_char
+    
+    # Returns true if a symbol is selected.
+    # @return [true,false]
+    def has_selection; end
+    alias_method :has_selection?, :has_selection
+    
+    # Sets the initial/selected font name.
+    # @param value [String] 
+    # @return [void]
+    def set_font_name(value) end
+    alias_method :font_name=, :set_font_name
+    
+    # Sets the internal flag indicating that the full Unicode range should be displayed.
+    # @param value [true,false] 
+    # @return [void]
+    def set_from_unicode(value) end
+    alias_method :from_unicode=, :set_from_unicode
+    
+    # Sets the name of the font to be used in the absence of a selected font.
+    # @param value [String] 
+    # @return [void]
+    def set_normal_text_font_name(value) end
+    alias_method :normal_text_font_name=, :set_normal_text_font_name
+    
+    # Sets the symbol as a one or zero character string.
+    # @param value [String] 
+    # @return [void]
+    def set_symbol(value) end
+    alias_method :symbol=, :set_symbol
+    
+    # Sets Unicode display mode.
+    # @param unicodeMode [true,false] 
+    # @return [void]
+    def set_unicode_mode(unicodeMode) end
+    alias_method :unicode_mode=, :set_unicode_mode
+    
+    # Returns true if the has specified normal text - that is, there is no selected font.
+    # @return [true,false]
+    def use_normal_font; end
+    
+  end # SymbolPickerDialog
+  
+
+end

data/lib/wx/doc/gen/sash_event.rb

@@ -0,0 +1,133 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  SW_NOBORDER = 0
+  
+  # 
+  SW_BORDER = 32
+  
+  # 
+  SW_3DSASH = 64
+  
+  # 
+  SW_3DBORDER = 128
+  
+  # 
+  SW_3D = 192
+  
+  # See {Wx::SashWindow}.
+  # 
+  # 
+  # 
+  class SashEdgePosition < Wx::Enum
+  
+    # 
+    # 
+    SASH_TOP = Wx::SashEdgePosition.new(0)
+    
+    # 
+    # 
+    SASH_RIGHT = Wx::SashEdgePosition.new(1)
+    
+    # 
+    # 
+    SASH_BOTTOM = Wx::SashEdgePosition.new(2)
+    
+    # 
+    # 
+    SASH_LEFT = Wx::SashEdgePosition.new(3)
+    
+    # 
+    # 
+    SASH_NONE = Wx::SashEdgePosition.new(100)
+    
+  end # SashEdgePosition
+  
+  # See {Wx::SashEvent}.
+  # 
+  # 
+  # 
+  class SashDragStatus < Wx::Enum
+  
+    # 
+    # 
+    SASH_STATUS_OK = Wx::SashDragStatus.new(0)
+    
+    # 
+    # 
+    SASH_STATUS_OUT_OF_RANGE = Wx::SashDragStatus.new(1)
+    
+  end # SashDragStatus
+  
+  # 
+  # 
+  EVT_SASH_DRAGGED = 10050
+  
+  # A sash event is sent when the sash of a {Wx::SashWindow} has been dragged by the user.
+  # When a sash belonging to a sash window is dragged by the user, and then released, this event is sent to the window, where it may be processed by an event table entry in a derived class, a plug-in event handler or an ancestor class. Note that the {Wx::SashWindow} doesn't change the window's size itself. It relies on the application's event handler to do that. This is because the application may have to handle other consequences of the resize, or it may wish to veto it altogether. The event handler should look at the drag rectangle: see {Wx::SashEvent#get_drag_rect} to see what the new size of the window would be if the resize were to be applied. It should also call {Wx::SashEvent#get_drag_status} to see whether the drag was OK or out of the current allowed range.
+  # 
+  # === Events using this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SashEvent} events.
+  # Event handler methods:
+  # - {Wx::EvtHandler#evt_sash_dragged}(id, meth = nil, &block): Process a {Wx::EVT_SASH_DRAGGED} event, when the user has finished dragging a sash. 
+  # - {Wx::EvtHandler#evt_sash_dragged_range}(id1,  id2, meth = nil, &block): Process a {Wx::EVT_SASH_DRAGGED_RANGE} event, when the user has finished dragging a sash. The event handler is called when windows with ids in the given range have their sashes dragged. 
+  # 
+  # === 
+  # 
+  # Category:  {Wx::Events}
+  # @see Wx::SashWindow
+  # @see  Events and Event Handling 
+  # 
+  # 
+  class SashEvent < CommandEvent
+  
+    # Constructor.
+    # @param id [Integer] 
+    # @param edge [SashEdgePosition] 
+    # @return [SashEvent]
+    def initialize(id=0, edge=Wx::SASH_NONE) end
+    
+    # Returns the rectangle representing the new size the window would be if the resize was applied.
+    # It is up to the application to set the window size if required.
+    # @return [Wx::Rect]
+    def get_drag_rect; end
+    alias_method :drag_rect, :get_drag_rect
+    
+    # Returns the status of the sash: one of {Wx::SashDragStatus::SASH_STATUS_OK}, {Wx::SashDragStatus::SASH_STATUS_OUT_OF_RANGE}.
+    # If the drag caused the notional bounding box of the window to flip over, for example, the drag will be out of rage.
+    # @return [SashDragStatus]
+    def get_drag_status; end
+    alias_method :drag_status, :get_drag_status
+    
+    # Returns the dragged edge.
+    # The return value is one of {Wx::SashEdgePosition::SASH_TOP}, {Wx::SashEdgePosition::SASH_RIGHT}, {Wx::SashEdgePosition::SASH_BOTTOM}, {Wx::SashEdgePosition::SASH_LEFT}.
+    # @return [SashEdgePosition]
+    def get_edge; end
+    alias_method :edge, :get_edge
+    
+    # @param edge [SashEdgePosition] 
+    # @return [void]
+    def set_edge(edge) end
+    alias_method :edge=, :set_edge
+    
+    # @param rect [Wx::Rect] 
+    # @return [void]
+    def set_drag_rect(rect) end
+    alias_method :drag_rect=, :set_drag_rect
+    
+    # @param status [SashDragStatus] 
+    # @return [void]
+    def set_drag_status(status) end
+    alias_method :drag_status=, :set_drag_status
+    
+  end # SashEvent
+  
+
+end