wxruby3 1.6.0 → 1.7.0

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

@@ -0,0 +1,129 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This class creates button layouts which conform to the standard button spacing and ordering defined by the platform or toolkit's user interface guidelines (if such things exist).
+  # 
+  # By using this class, you can ensure that all your standard dialogs look correct on all major platforms. Currently it conforms to the Windows, GTK+ and macOS human interface guidelines.
+  # When there aren't interface guidelines defined for a particular platform or toolkit, {Wx::StdDialogButtonSizer} reverts to the Windows implementation.
+  # To use this class, first add buttons to the sizer by calling {Wx::StdDialogButtonSizer#add_button} (or {Wx::StdDialogButtonSizer#set_affirmative_button}, {Wx::StdDialogButtonSizer#set_negative_button} or {Wx::StdDialogButtonSizer#set_cancel_button}) and then call Realize in order to create the actual button layout used. Other than these special operations, this sizer works like any other sizer.
+  # If you add a button with {Wx::StandardID::ID_SAVE}, on macOS the button will be renamed to "Save" and the {Wx::StandardID::ID_NO} button will be renamed to "Don't Save" in accordance with the macOS Human Interface Guidelines.
+  # 
+  # Category:  Window Layout
+  # @see Wx::Sizer
+  # @see  Sizers Overview
+  # @see  Wx::Dialog#create_button_sizer 
+  # 
+  # 
+  class StdDialogButtonSizer < BoxSizer
+  
+    # @overload initialize()
+    #   Constructor for a {Wx::StdDialogButtonSizer}.
+    #   @return [Wx::StdDialogButtonSizer]
+    # @overload initialize(&block)
+    #   Constructor for a {Wx::StdDialogButtonSizer}.
+    #   @yieldparam [Wx::StdDialogButtonSizer] sizer new Sizer instance
+    #   @return [Wx::StdDialogButtonSizer]
+    def initialize(*args) end
+    
+    # Adds a button to the {Wx::StdDialogButtonSizer}.
+    # 
+    # The button must have one of the following identifiers:
+    # 
+    # - {Wx::StandardID::ID_OK}
+    # - {Wx::StandardID::ID_YES}
+    # - {Wx::StandardID::ID_SAVE}
+    # - {Wx::StandardID::ID_APPLY}
+    # - {Wx::StandardID::ID_CLOSE}
+    # - {Wx::StandardID::ID_NO}
+    # - {Wx::StandardID::ID_CANCEL}
+    # - {Wx::StandardID::ID_HELP}
+    # - {Wx::StandardID::ID_CONTEXT_HELP}
+    # @param button [Wx::Button] 
+    # @return [void]
+    def add_button(button) end
+    
+    # Rearranges the buttons and applies proper spacing between buttons to make them match the platform or toolkit's interface guidelines.
+    # @return [void]
+    def realize; end
+    
+    # Returns the affirmative button for the sizer.
+    # 
+    # Affirmative buttons are those added with ID {Wx::StandardID::ID_OK}, {Wx::StandardID::ID_YES} or {Wx::StandardID::ID_SAVE}. They can have other ID if they were added calling {Wx::StdDialogButtonSizer#set_affirmative_button}.
+    # @return [Wx::Button]
+    def get_affirmative_button; end
+    alias_method :affirmative_button, :get_affirmative_button
+    
+    # Returns the apply button for the sizer.
+    # 
+    # Apply buttons are those added with ID {Wx::StandardID::ID_APPLY}.
+    # @return [Wx::Button]
+    def get_apply_button; end
+    alias_method :apply_button, :get_apply_button
+    
+    # Returns the negative button for the sizer.
+    # 
+    # Negative buttons are those added with ID {Wx::StandardID::ID_NO}. They can have other ID if they were added calling {Wx::StdDialogButtonSizer#set_negative_button}.
+    # @return [Wx::Button]
+    def get_negative_button; end
+    alias_method :negative_button, :get_negative_button
+    
+    # Returns the cancel button for the sizer.
+    # 
+    # Cancel buttons are those added with ID {Wx::StandardID::ID_CANCEL} or {Wx::StandardID::ID_CLOSE}. They can have other ID if they were added calling {Wx::StdDialogButtonSizer#set_cancel_button}.
+    # @return [Wx::Button]
+    def get_cancel_button; end
+    alias_method :cancel_button, :get_cancel_button
+    
+    # Returns the help button for the sizer.
+    # 
+    # Help buttons are those added with ID {Wx::StandardID::ID_HELP} or {Wx::StandardID::ID_CONTEXT_HELP}.
+    # @return [Wx::Button]
+    def get_help_button; end
+    alias_method :help_button, :get_help_button
+    
+    # Sets the affirmative button for the sizer.
+    # 
+    # This allows you to use identifiers other than the standard identifiers outlined above.
+    # @param button [Wx::Button] 
+    # @return [void]
+    def set_affirmative_button(button) end
+    alias_method :affirmative_button=, :set_affirmative_button
+    
+    # Sets the cancel button for the sizer.
+    # 
+    # This allows you to use identifiers other than the standard identifiers outlined above.
+    # @param button [Wx::Button] 
+    # @return [void]
+    def set_cancel_button(button) end
+    alias_method :cancel_button=, :set_cancel_button
+    
+    # Sets the negative button for the sizer.
+    # 
+    # This allows you to use identifiers other than the standard identifiers outlined above.
+    # @param button [Wx::Button] 
+    # @return [void]
+    def set_negative_button(button) end
+    alias_method :negative_button=, :set_negative_button
+    
+    # Method which must be overridden in the derived sizer classes.
+    # 
+    # The implementation should reposition the children using the current total size available to the sizer (m_size) and the size computed by the last call to {Wx::StdDialogButtonSizer#calc_min}.
+    # @param minSize [Array(Integer, Integer), Wx::Size] 
+    # @return [void]
+    def reposition_children(minSize) end
+    
+    # Implements the calculation of a box sizer's minimal.
+    # 
+    # It is used internally only and must not be called by the user. Documented for information.
+    # @return [Wx::Size]
+    def calc_min; end
+    
+  end # StdDialogButtonSizer
+  
+
+end

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

@@ -0,0 +1,164 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # SVG shape rendering mode.
+  # 
+  # These options represent the values defined in the SVG specification: https://svgwg.org/svg2-draft/painting.html\#ShapeRenderingProperty
+  # 
+  # @wxrb_require USE_SVG
+  class SVGShapeRenderingMode < Wx::Enum
+  
+    # 
+    # 
+    SVG_SHAPE_RENDERING_AUTO = Wx::SVGShapeRenderingMode.new(0)
+    
+    # 
+    # 
+    SVG_SHAPE_RENDERING_OPTIMIZE_SPEED = Wx::SVGShapeRenderingMode.new(1)
+    
+    # 
+    # 
+    SVG_SHAPE_RENDERING_CRISP_EDGES = Wx::SVGShapeRenderingMode.new(2)
+    
+    # 
+    # 
+    SVG_SHAPE_RENDERING_GEOMETRIC_PRECISION = Wx::SVGShapeRenderingMode.new(3)
+    
+    # 
+    # 
+    SVG_SHAPE_RENDERING_OPTIMISE_SPEED = Wx::SVGShapeRenderingMode.new(1)
+    
+  end # SVGShapeRenderingMode
+  
+  # Value indicating the default dpi resolution of {Wx::SVGFileDC}.
+  # 
+  SVG_DEFAULT_DPI = 72.0
+  
+  # A {Wx::SVGFileDC} is a device context onto which graphics and text can be drawn, and the output produced as a vector file, in SVG format.
+  # 
+  # This format can be read by a range of programs, including a Netscape plugin (Adobe) and the open source Inkscape program (http://inkscape.org/). Full details are given in the W3C SVG recommendation (http://www.w3.org/TR/SVG/).
+  # The intention behind {Wx::SVGFileDC} is that it can be used to produce a file corresponding to the screen display context, {Wx::SVGFileDC}, by passing the {Wx::SVGFileDC} as a parameter instead of a {Wx::DC}. Thus the {Wx::SVGFileDC} is a write-only class.
+  # As the {Wx::SVGFileDC} is a vector format, raster operations like {Wx::SVGFileDC#get_pixel} are unlikely to be supported. However, the SVG specification allows for raster files to be embedded in the SVG, and so bitmaps, icons and blit operations in {Wx::SVGFileDC} are supported. By default only PNG format bitmaps are supported and these are saved as separate files in the same folder as the SVG file, however it is possible to change this behaviour by replacing the built in bitmap handler using {Wx::SVGFileDC#set_bitmap_handler}.
+  # More substantial SVG libraries (for reading and writing) are available at {Wx::Art2D} and {Wx::SVG}.
+  # 
+  # Category:  Device Contexts
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_SVG
+  class SVGFileDC < DC
+  
+    # Draws a rectangle the size of the SVG using the {Wx::DC#set_background} brush.
+    # @return [void]
+    def clear; end
+    
+    # Replaces the default bitmap handler with handler.
+    # 
+    # By default, an object of {Wx::SVGBitmapFileHandler} class is used as bitmap handler. You may want to replace it with an object of predefined {Wx::SVGBitmapEmbedHandler} class to embed the bitmaps in the generated SVG instead of storing them in separate files like this: 
+    # ```ruby
+    #   mySVGFileDC.set_bitmap_handler(Wx::SVGBitmapEmbedHandler.new)
+    # ```
+    # 
+    # or derive your own bitmap handler class and use it if you need to customize the bitmap handling further.
+    # @param handler [Wx::SVGBitmapHandler]  The new bitmap handler. If non-null, this object takes ownership of this handler and will delete it when it is not needed any more.
+    # @return [void]
+    def set_bitmap_handler(handler) end
+    alias_method :bitmap_handler=, :set_bitmap_handler
+    
+    # Set the shape rendering mode of the generated SVG.
+    # 
+    # All subsequent drawing calls will have this rendering mode set in the SVG file.
+    # The default mode is {Wx::SVGShapeRenderingMode::SVG_SHAPE_RENDERING_AUTO}.
+    # @param renderingMode [Wx::SVGShapeRenderingMode] 
+    # @return [void]
+    def set_shape_rendering_mode(renderingMode) end
+    alias_method :shape_rendering_mode=, :set_shape_rendering_mode
+    
+  end # SVGFileDC
+  
+  # Abstract base class for handling bitmaps inside a {Wx::SVGFileDC}.
+  # 
+  # To use it you need to derive a new class from it and override {Wx::SVGBitmapHandler#process_bitmap} to generate a properly a formed SVG image element (see http://www.w3.org/TR/SVG/struct.html\#ImageElement).
+  # Two example bitmap handlers are provided in {Wx::/dcsvg.h}. The first (default) handler will create PNG files in the same folder as the SVG file and uses links to them in the SVG. The second handler ({Wx::SVGBitmapEmbedHandler}) will embed the PNG image in the SVG file using base 64 encoding.
+  # The handler can be changed by calling {Wx::SVGFileDC#set_bitmap_handler}.
+  # 
+  # Category:  Device Contexts
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_SVG
+  class SVGBitmapHandler < ::Object
+  
+    # Writes the bitmap representation as SVG to the given stream.
+    # 
+    # The XML generated by this function will be inserted into the SVG file inline with the XML generated by the main {Wx::SVGFileDC} class so it is important that the XML is properly formed.
+    # @param bitmap [Wx::Bitmap]  A valid bitmap to add to SVG.
+    # @param x [Integer]  Horizontal position of the bitmap.
+    # @param y [Integer]  Vertical position of the bitmap.
+    # @param stream [Wx::OutputStream]  The stream to write SVG contents to.
+    # @return [Boolean]
+    def process_bitmap(bitmap, x, y, stream) end
+    
+  end # SVGBitmapHandler
+  
+  # Handler saving bitmaps to external PNG files and linking to it from the SVG.
+  # 
+  # This handler is used by default by {Wx::SVGFileDC}. PNG files are created in the same folder as the SVG file and are named using the SVG filename appended with <code>_image#.png</code>.
+  # When using {Wx::SVGFileDC#set_bitmap_handler} to set this handler with the default constructor, the PNG files are created in the runtime location of the application. The save location can be customized by using the wxSVGBitmapFileHandler(const wxFileName&) constructor.
+  # 
+  # Category:  Device Contexts
+  # @see Wx::SVGFileDC#set_bitmap_handler.
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_SVG
+  class SVGBitmapFileHandler < SVGBitmapHandler
+  
+    # Create a {Wx::SVGBitmapFileHandler} and specify the location where the file will be saved.
+    # @param path [String]  The path of the save location. If path contains a filename, the autogenerated filename will be appended to this name.
+    # @return [Wx::SVGBitmapFileHandler]
+    def initialize(path) end
+    
+    # Writes the bitmap representation as SVG to the given stream.
+    # 
+    # The XML generated by this function will be inserted into the SVG file inline with the XML generated by the main {Wx::SVGFileDC} class so it is important that the XML is properly formed.
+    # @param bitmap [Wx::Bitmap]  A valid bitmap to add to SVG.
+    # @param x [Integer]  Horizontal position of the bitmap.
+    # @param y [Integer]  Vertical position of the bitmap.
+    # @param stream [Wx::OutputStream]  The stream to write SVG contents to.
+    # @return [Boolean]
+    def process_bitmap(bitmap, x, y, stream) end
+    
+  end # SVGBitmapFileHandler
+  
+  # Handler embedding bitmaps as base64-encoded PNGs into the SVG.
+  # 
+  # Category:  Device Contexts
+  # @see Wx::SVGFileDC#set_bitmap_handler.
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_SVG
+  class SVGBitmapEmbedHandler < SVGBitmapHandler
+  
+    # Writes the bitmap representation as SVG to the given stream.
+    # 
+    # The XML generated by this function will be inserted into the SVG file inline with the XML generated by the main {Wx::SVGFileDC} class so it is important that the XML is properly formed.
+    # @param bitmap [Wx::Bitmap]  A valid bitmap to add to SVG.
+    # @param x [Integer]  Horizontal position of the bitmap.
+    # @param y [Integer]  Vertical position of the bitmap.
+    # @param stream [Wx::OutputStream]  The stream to write SVG contents to.
+    # @return [Boolean]
+    def process_bitmap(bitmap, x, y, stream) end
+    
+  end # SVGBitmapEmbedHandler
+  
+
+end

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

@@ -0,0 +1,129 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # {Wx::SystemOptions} stores option/value pairs that wxWidgets itself or applications can use to alter behaviour at run-time.
+  # 
+  # It can be used to optimize behaviour that doesn't deserve a distinct API, but is still important to be able to configure.
+  # System options can be set by the program itself using {Wx::SystemOptions.set_option} method and they also can be set from the program environment by defining an environment variable {Wx::_option} to set the given option for all wxWidgets applications or {Wx::_appname_option} to set it just for the application with the given name (as returned by {Wx::App#get_app_name}). Notice that any characters not allowed in the environment variables names, such as periods and dashes, should be replaced with underscores. E.g. to define a system option "foo-bar" you need to define the environment variable "{Wx::_foo_bar}".
+  # The program may use system options for its own needs but they are mostly used to control the behaviour of wxWidgets library itself.
+  # These options are currently recognised by wxWidgets:
+  # 
+  # ## All platforms
+  # 
+  # - exit-on-assert: If set to non-zero value, abort the program if an assertion fails. The default behaviour in case of assertion failure depends on the build mode and can be changed by overriding {Wx::App#on_assert_failure} but setting this option allows changing it without modifying the program code and also applies to asserts which may happen before the {Wx::App} object creation or after its destruction. 
+  # 
+  # - catch-unhandled-exceptions: If set to zero, wxWidgets will not catch unhandled exceptions, but rather lets the default behaviour of aborting the program take place. Not catching unhandled exceptions makes debugging easier, as the backtrace is more likely to show what actually happened, and where. The same applies to any crash dumps generated due to unhandled exceptions. By default unhandled exceptions are eventually caught by wxWidgets. This flag should be set very early during program startup, within the constructor of the {Wx::App} derivative. This option has been added in wxWidgets 3.3.0. 
+  # 
+  # ## Windows
+  # 
+  # - no-maskblt: 1 to never use WIN32's MaskBlt function, 0 to allow it to be used where possible. Default: 0. In some circumstances the MaskBlt function can be slower than using the fallback code, especially if using DC caching. By default, MaskBlt will be used where it is implemented by the operating system and driver. 
+  # 
+  # - msw.remap: If 1 (the default), {Wx::ToolBar} bitmap colours will be remapped to the current theme's values. Set this to 0 to disable this functionality, for example if you're using more than 16 colours in your tool bitmaps. 
+  # 
+  # - msw.window.no-clip-children: If 1, windows will not automatically get the WS_CLIPCHILDREN style. This restores the way windows are refreshed back to the method used in versions of wxWidgets earlier than 2.5.4, and for some complex window hierarchies it can reduce apparent refresh delays. You may still specify {Wx::CLIP_CHILDREN} for individual windows. 
+  # 
+  # - msw.notebook.themed-background: If set to 0, globally disables themed backgrounds on notebook pages. Note that this won't disable the theme on the actual notebook background (noticeable only if there are no pages). 
+  # 
+  # - msw.staticbox.optimized-paint: If set to 0, switches off optimized {Wx::StaticBox} painting. Setting this to 0 causes more flicker, but allows applications to paint graphics on the parent of a static box (the optimized refresh causes any such drawing to disappear). 
+  # 
+  # - msw.font.no-proof-quality: If set to 1, use default fonts quality instead of proof quality when creating fonts. With proof quality the fonts have slightly better appearance but not all fonts are available in this quality, e.g. the Terminal font in small sizes is not and this option may be used if wider fonts selection is more important than higher quality. 
+  # 
+  # - msw.dark-mode: If set to 1, enable experimental support of dark mode if the system is using it, i.e. this has the same effect as calling {Wx::App#msw_enable_dark_mode}. If set to 2, use dark mode unconditionally, as if this function were called with {Wx::App::DarkMode_Always} argument. 
+  # 
+  # - msw.native-dialogs-pmdpi: Some native win32 dialogs (like the font and colour pickers) are not per-monitor DPI aware, and wxWidgets will forcefully show them as system DPI aware when there are monitors with different DPI connected. If set to 1, these dialogs will always be shown as per-monitor DPI aware (when enabled in the manifest). 
+  # 
+  # ## GTK+
+  # 
+  # - gtk.tlw.can-set-transparent: {Wx::TopLevelWindow#can_set_transparent} method normally tries to detect automatically whether transparency for top level windows is currently supported, however this may sometimes fail and this option allows overriding the automatic detection. Setting it to 1 makes the transparency be always available (setting it can still fail, of course) and setting it to 0 makes it always unavailable. 
+  # 
+  # - gtk.desktop: This option can be set to override the default desktop environment determination. Supported values are GNOME and KDE. 
+  # 
+  # - gtk.window.force-background-colour: If 1, the backgrounds of windows with the {Wx::BackgroundStyle::BG_STYLE_COLOUR} background style are cleared forcibly instead of relying on the underlying GTK+ window colour. This works around a display problem when running applications under KDE with the gtk-qt theme installed (0.6 and below). 
+  # 
+  # ## Mac
+  # 
+  # - mac.window-plain-transition: If 1, uses a plainer transition when showing a window. You can also use the symbol {Wx::MAC_WINDOW_PLAIN_TRANSITION}. 
+  # 
+  # - window-default-variant: The default variant used by windows (cast to integer from the {Wx::WindowVariant} enum). Also known as {Wx::WINDOW_DEFAULT_VARIANT}. 
+  # 
+  # - mac.textcontrol-use-spell-checker: If 1 activates the spell checking in {Wx::TextCtrl}. 
+  # 
+  # - osx.openfiledialog.always-show-types: Per default a {Wx::FileDialog} with {Wx::FD_OPEN} does not show a types-popup on macOS but allows the selection of files from any of the supported types. Setting this to 1 shows a {Wx::Choice} for selection (if there is more than one supported filetype). 
+  # 
+  # The compile-time option to include or exclude this functionality is {Wx::Setup::USE_SYSTEM_OPTIONS}.
+  # 
+  # Category:  Application and System configuration
+  # @see Wx::SystemSettings 
+  # 
+  # 
+  # @wxrb_require USE_SYSTEM_OPTIONS
+  class SystemOptions < Object
+  
+    # @overload self.set_option(name, value)
+    #   Sets an option.
+    #   
+    #   The function is case-insensitive to name.
+    #   @param name [String] 
+    #   @param value [String] 
+    #   @return [void]
+    # @overload self.set_option(name, value)
+    #   Sets an option.
+    #   
+    #   The function is case-insensitive to name.
+    #   @param name [String] 
+    #   @param value [Integer] 
+    #   @return [void]
+    def self.set_option(*args) end
+    
+    # Default constructor.
+    # 
+    # You don't need to create an instance of {Wx::SystemOptions} since all of its functions are static.
+    # @return [Wx::SystemOptions]
+    def initialize; end
+    
+    # Gets an option.
+    # 
+    # The function is case-insensitive to name. Returns empty string if the option hasn't been set.
+    # @see Wx::SystemOptions.set_option
+    # @see  Wx::SystemOptions.get_option_int
+    # @see  Wx::SystemOptions.has_option 
+    # @param name [String] 
+    # @return [String]
+    def self.get_option(name) end
+    
+    # Gets an option as an integer.
+    # 
+    # The function is case-insensitive to name. If the option hasn't been set, this function returns 0.
+    # @see Wx::SystemOptions.set_option
+    # @see  Wx::SystemOptions.get_option
+    # @see  Wx::SystemOptions.has_option 
+    # @param name [String] 
+    # @return [Integer]
+    def self.get_option_int(name) end
+    
+    # Returns true if the given option is present.
+    # 
+    # The function is case-insensitive to name.
+    # @see Wx::SystemOptions.set_option
+    # @see  Wx::SystemOptions.get_option
+    # @see  Wx::SystemOptions.get_option_int 
+    # @param name [String] 
+    # @return [Boolean]
+    def self.has_option(name) end
+    
+    # Returns true if the option with the given name had been set to 0 value.
+    # 
+    # This is mostly useful for boolean options for which you can't use <code>GetOptionInt(name)</code> == 0 as this would also be true if the option hadn't been set at all.
+    # @param name [String] 
+    # @return [Boolean]
+    def self.is_false(name) end
+    
+  end # SystemOptions
+  
+
+end