wxruby3 1.6.0 → 1.7.0

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

@@ -0,0 +1,151 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This class holds a variety of information related to font dialogs.
+  # 
+  # Category:  Common Dialogs, Data Structures
+  # @see wxFontDialog Overview
+  # @see  Wx::Font
+  # @see  Wx::FontDialog 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_FONTDLG
+  class FontData < Object
+  
+    # Constructor.
+    # 
+    # Initializes fontColour to black, showHelp to false, allowSymbols to true, enableEffects to true, minSize to 0 and maxSize to 0.
+    # @return [Wx::FontData]
+    def initialize; end
+    
+    # Enables or disables "effects" under Windows or generic only.
+    # 
+    # This refers to the controls for manipulating colour, strikeout and underline properties.
+    # The default value is true.
+    # @param enable [Boolean] 
+    # @return [void]
+    def enable_effects(enable) end
+    
+    # Under Windows, returns a flag determining whether symbol fonts can be selected.
+    # 
+    # Has no effect on other platforms.
+    # The default value is true.
+    # @return [Boolean]
+    def get_allow_symbols; end
+    alias_method :allow_symbols, :get_allow_symbols
+    
+    # Gets the font chosen by the user if the user pressed OK ({Wx::FontDialog#show_modal} returned {Wx::StandardID::ID_OK}).
+    # @return [Wx::Font]
+    def get_chosen_font; end
+    alias_method :chosen_font, :get_chosen_font
+    
+    # Gets the colour associated with the font dialog.
+    # 
+    # The default value is black.
+    # @return [Wx::Colour,String,Symbol]
+    def get_colour; end
+    alias_method :colour, :get_colour
+    
+    # Determines whether "effects" are enabled under Windows.
+    # 
+    # This refers to the controls for manipulating colour, strikeout and underline properties.
+    # The default value is true.
+    # @return [Boolean]
+    def get_enable_effects; end
+    
+    # Returns the state of the flags restricting the selection.
+    # 
+    # Note that currently these flags are only effectively used in WXMSW.
+    # 
+    # - {Wx::FONTRESTRICT_NONE} If no restriction applies, or a combination of the following flags:
+    # - {Wx::FONTRESTRICT_SCALABLE} To show only scalable fonts - no raster fonts.
+    # - {Wx::FONTRESTRICT_FIXEDPITCH} To show only monospaced fonts.
+    # 
+    # The default value is {Wx::FONTRESTRICT_NONE}.
+    # @return [Integer]
+    def get_restrict_selection; end
+    
+    # Gets the font that will be initially used by the font dialog.
+    # 
+    # This should have previously been set by the application.
+    # @return [Wx::Font]
+    def get_initial_font; end
+    alias_method :initial_font, :get_initial_font
+    
+    # Returns true if the Help button will be shown (Windows only).
+    # 
+    # The default value is false.
+    # @return [Boolean]
+    def get_show_help; end
+    alias_method :show_help, :get_show_help
+    
+    # Restricts the selection to a subset of the available fonts.
+    # 
+    # Note that currently these flags are only effectively used in WXMSW and are ignored in the other ports.
+    # Possible values are:
+    # 
+    # - {Wx::FONTRESTRICT_NONE} No restriction, show all fonts in the dialog.
+    # - {Wx::FONTRESTRICT_SCALABLE} To show only scalable fonts - no raster fonts.
+    # - {Wx::FONTRESTRICT_FIXEDPITCH} To show only monospaced fonts.
+    # 
+    # The default value is {Wx::FONTRESTRICT_NONE}.
+    # @param flags [Integer] 
+    # @return [void]
+    def restrict_selection(flags) end
+    
+    # Under Windows, determines whether symbol fonts can be selected.
+    # 
+    # Has no effect on other platforms.
+    # The default value is true.
+    # @param allowSymbols [Boolean] 
+    # @return [void]
+    def set_allow_symbols(allowSymbols) end
+    alias_method :allow_symbols=, :set_allow_symbols
+    
+    # Sets the font that will be returned to the user (for internal use only).
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_chosen_font(font) end
+    alias_method :chosen_font=, :set_chosen_font
+    
+    # Sets the colour that will be used for the font foreground colour.
+    # 
+    # The default colour is black.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_colour(colour) end
+    alias_method :colour=, :set_colour
+    
+    # Sets the font that will be initially used by the font dialog.
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_initial_font(font) end
+    alias_method :initial_font=, :set_initial_font
+    
+    # Sets the valid range for the font point size (Windows only).
+    # 
+    # The default is 0, 0 (unrestricted range).
+    # @param min [Integer] 
+    # @param max [Integer] 
+    # @return [void]
+    def set_range(min, max) end
+    
+    # Determines whether the Help button will be displayed in the font dialog (Windows only).
+    # 
+    # The default value is false.
+    # @param showHelp [Boolean] 
+    # @return [void]
+    def set_show_help(showHelp) end
+    alias_method :show_help=, :set_show_help
+    
+  end # FontData
+  
+
+end

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

@@ -0,0 +1,88 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Shows the font selection dialog and returns the font selected by user or invalid font (use {Wx::Font#is_ok} to test whether a font is valid) if the dialog was cancelled.
+  # @param parent [Wx::Window]  The parent window for the font selection dialog.
+  # @param fontInit [Wx::Font,Wx::FontInfo]  If given, this will be the font initially selected in the dialog.
+  # @param caption [String]  If given, this will be used for the dialog caption.
+  # @return [Wx::Font]
+  def self.get_font_from_user(parent=nil, fontInit=Wx::NULL_FONT, caption=('')) end
+  
+  # This class represents the font chooser dialog.
+  # 
+  # Category:  Common Dialogs
+  # @see wxFontDialog Overview
+  # @see  Wx::FontData
+  # @see  get_font_from_user 
+  # 
+  # 
+  # @wxrb_require USE_FONTDLG
+  class FontDialog < Dialog
+  
+    # Returns the font data associated with the font dialog.
+    # @return [Wx::FontData]
+    def get_font_data; end
+    alias_method :font_data, :get_font_data
+    
+    # @overload initialize()
+    #   Default ctor.
+    #   
+    #   {Wx::FontDialog#create} must be called before the dialog can be shown.
+    #   @return [Wx::FontDialog]
+    # @overload initialize(parent)
+    #   Constructor with parent window.
+    #   @param parent [Wx::Window] 
+    #   @return [Wx::FontDialog]
+    # @overload initialize(parent, &block)
+    #   Constructor with parent window.
+    #   @param parent [Wx::Window] 
+    #   @yieldparam [Wx::FontDialog] win new instance
+    #   @return [Wx::FontDialog]
+    # @overload initialize(parent, data)
+    #   Constructor.
+    #   
+    #   Pass a parent window, and the font data object to be used to initialize the dialog controls.
+    #   @param parent [Wx::Window] 
+    #   @param data [Wx::FontData] 
+    #   @return [Wx::FontDialog]
+    # @overload initialize(parent, data, &block)
+    #   Constructor.
+    #   
+    #   Pass a parent window, and the font data object to be used to initialize the dialog controls.
+    #   @param parent [Wx::Window] 
+    #   @param data [Wx::FontData] 
+    #   @yieldparam [Wx::FontDialog] win new instance
+    #   @return [Wx::FontDialog]
+    def initialize(*args) end
+    
+    # @overload create(parent)
+    #   Creates the dialog if the {Wx::FontDialog} object had been initialized using the default constructor.
+    #   
+    #   true on success and false if an error occurred.
+    #   @param parent [Wx::Window] 
+    #   @return [Boolean]
+    # @overload create(parent, data)
+    #   Creates the dialog if the {Wx::FontDialog} object had been initialized using the default constructor.
+    #   
+    #   true on success and false if an error occurred.
+    #   @param parent [Wx::Window] 
+    #   @param data [Wx::FontData] 
+    #   @return [Boolean]
+    def create(*args) end
+    
+    # Shows the dialog, returning {Wx::StandardID::ID_OK} if the user pressed Ok, and {Wx::StandardID::ID_CANCEL} otherwise.
+    # 
+    # If the user cancels the dialog (ShowModal returns {Wx::StandardID::ID_CANCEL}), no font will be created. If the user presses OK, a new {Wx::Font} will be created and stored in the font dialog's {Wx::FontData} structure.
+    # @see Wx::FontDialog#get_font_data 
+    # @return [Integer]
+    def show_modal; end
+    
+  end # FontDialog
+  
+
+end

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

@@ -0,0 +1,143 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This control allows the user to select a font.
+  # 
+  # The generic implementation is a button which brings up a {Wx::FontDialog} when clicked. Native implementation may differ but this is usually a (small) widget which give access to the font-chooser dialog. It is only available if {Wx::Setup::USE_FONTPICKERCTRL} is set to 1 (the default).
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::FNTP_DEFAULT_STYLE}: The default style: {Wx::FNTP_FONTDESC_AS_LABEL} | {Wx::FNTP_USEFONT_FOR_LABEL}. 
+  # 
+  # - {Wx::FNTP_USE_TEXTCTRL}: Creates a text control to the left of the picker button which is completely managed by the {Wx::FontPickerCtrl} and which can be used by the user to specify a font (see SetSelectedFont). The text control is automatically synchronized with button's value. Use functions defined in {Wx::PickerBase} to modify the text control. 
+  # 
+  # - {Wx::FNTP_FONTDESC_AS_LABEL}: Keeps the label of the button updated with the fontface name and the font size. E.g. choosing "Times New Roman bold, italic with
+  # size 10" from the fontdialog, will update the label (overwriting any previous label) with the "Times New Roman, 10" text. 
+  # 
+  # - {Wx::FNTP_USEFONT_FOR_LABEL}: Uses the currently selected font to draw the label of the button. 
+  # 
+  # ### Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::FontPickerEvent} events.
+  # Event handler methods for events emitted by this class:
+  # 
+  # - {Wx::EvtHandler#evt_fontpicker_changed}(id, meth = nil, &block): The user changed the font selected in the control either using the button or using text control (see {Wx::FNTP_USE_TEXTCTRL}; note that in this case the event is fired only if the user's input is valid, i.e. recognizable). 
+  # 
+  # Category:  Picker Controls  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
+  #   </td></tr></table></div>
+  # @see Wx::FontDialog
+  # @see  Wx::FontPickerEvent 
+  # 
+  # 
+  # @wxrb_require USE_FONTDLG,USE_FONTPICKERCTRL
+  class FontPickerCtrl < PickerBase
+  
+    # @overload initialize()
+    #   @return [Wx::FontPickerCtrl]
+    # @overload initialize(parent, id, font=Wx::NULL_FONT, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::FNTP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::FONT_PICKER_CTRL_NAME_STR)
+    #   Initializes the object and calls {Wx::FontPickerCtrl#create} with all the parameters.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param font [Wx::Font,Wx::FontInfo] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param validator [Wx::Validator] 
+    #   @param name [String] 
+    #   @return [Wx::FontPickerCtrl]
+    # @overload initialize(parent, id, font=Wx::NULL_FONT, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::FNTP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::FONT_PICKER_CTRL_NAME_STR, &block)
+    #   Initializes the object and calls {Wx::FontPickerCtrl#create} with all the parameters.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param font [Wx::Font,Wx::FontInfo] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param validator [Wx::Validator] 
+    #   @param name [String] 
+    #   @yieldparam [Wx::FontPickerCtrl] win new instance
+    #   @return [Wx::FontPickerCtrl]
+    def initialize(*args) end
+    
+    # Creates this widget with given parameters.
+    # 
+    # true if the control was successfully created or false if creation failed.
+    # @param parent [Wx::Window]  Parent window, must not be non-null.
+    # @param id [Integer]  The identifier for the control.
+    # @param font [Wx::Font,Wx::FontInfo]  The initial font shown in the control. If {Wx::NULL_FONT} is given, the default font is used.
+    # @param pos [Array(Integer, Integer), Wx::Point]  Initial position.
+    # @param size [Array(Integer, Integer), Wx::Size]  Initial size.
+    # @param style [Integer]  The window style, see {Wx::FNTP_}* flags.
+    # @param validator [Wx::Validator]  Validator which can be used for additional data checks.
+    # @param name [String]  Control name.
+    # @return [Boolean]
+    def create(parent, id, font=Wx::NULL_FONT, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::FNTP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::FONT_PICKER_CTRL_NAME_STR) end
+    
+    # Returns the maximum point size value allowed for the user-chosen font.
+    # @return [Integer]
+    def get_max_point_size; end
+    alias_method :max_point_size, :get_max_point_size
+    
+    # Returns the minimum point size value allowed for the user-chosen font.
+    # @return [Integer]
+    def get_min_point_size; end
+    alias_method :min_point_size, :get_min_point_size
+    
+    # Returns the currently selected colour.
+    # 
+    # Note that the colour of the font can only be set by the user under Windows currently, elsewhere this method simply returns the colour previously set by {Wx::FontPickerCtrl#set_selected_colour} or black if it hadn't been called.
+    # @return [Wx::Colour]
+    def get_selected_colour; end
+    alias_method :selected_colour, :get_selected_colour
+    
+    # Returns the currently selected font.
+    # 
+    # Note that this function is completely different from {Wx::Window#get_font}.
+    # @return [Wx::Font]
+    def get_selected_font; end
+    alias_method :selected_font, :get_selected_font
+    
+    # Sets the maximum point size value allowed for the user-chosen font.
+    # 
+    # The default value is 100. Note that big fonts can require a lot of memory and CPU time both for creation and for rendering; thus, specially because the user has the option to specify the fontsize through a text control (see {Wx::FNTP_USE_TEXTCTRL}), it's a good idea to put a limit to the maximum font size when huge fonts do not make much sense.
+    # @param max [Integer] 
+    # @return [void]
+    def set_max_point_size(max) end
+    alias_method :max_point_size=, :set_max_point_size
+    
+    # Sets the minimum point size value allowed for the user-chosen font.
+    # 
+    # The default value is 0.
+    # @param min [Integer] 
+    # @return [void]
+    def set_min_point_size(min) end
+    alias_method :min_point_size=, :set_min_point_size
+    
+    # Sets the font colour.
+    # 
+    # The font colour is actually only used under Windows currently, but this function is available under all platforms for consistency.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_selected_colour(colour) end
+    alias_method :selected_colour=, :set_selected_colour
+    
+    # Sets the currently selected font.
+    # 
+    # Note that this function is completely different from {Wx::Window#set_font}.
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_selected_font(font) end
+    alias_method :selected_font=, :set_selected_font
+    
+  end # FontPickerCtrl
+  
+
+end

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

@@ -0,0 +1,65 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  FNTP_FONTDESC_AS_LABEL = 8
+  
+  # 
+  FNTP_USEFONT_FOR_LABEL = 16
+  
+  # 
+  FONTBTN_DEFAULT_STYLE = 24
+  
+  # 
+  FNTP_USE_TEXTCTRL = 2
+  
+  # 
+  FNTP_DEFAULT_STYLE = 24
+  
+  # 
+  # 
+  EVT_FONTPICKER_CHANGED = 10164
+  
+  # This event class is used for the events generated by {Wx::FontPickerCtrl}.
+  # 
+  # ### Events using this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::FontPickerEvent} events.
+  # Event handler methods:
+  # 
+  # - {Wx::EvtHandler#evt_fontpicker_changed}(id, meth = nil, &block): Generated whenever the selected font changes. 
+  # 
+  # Category:  {Wx::Events}
+  # @see Wx::FontPickerCtrl 
+  # 
+  # 
+  # @wxrb_require USE_FONTDLG,USE_FONTPICKERCTRL
+  class FontPickerEvent < CommandEvent
+  
+    # The constructor is not normally used by the user code.
+    # @param generator [Wx::Object] 
+    # @param id [Integer] 
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [Wx::FontPickerEvent]
+    def initialize(generator, id, font) end
+    
+    # Retrieve the font the user has just selected.
+    # @return [Wx::Font]
+    def get_font; end
+    alias_method :font, :get_font
+    
+    # Set the font associated with the event.
+    # @param f [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_font(f) end
+    alias_method :font=, :set_font
+    
+  end # FontPickerEvent
+  
+
+end