wxruby3 0.9.4-x64-mingw-ucrt → 0.9.7-x64-mingw-ucrt

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

@@ -6,147 +6,151 @@
 
 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.
-  # 
-  # ```ruby
-  #   ctrl = find_window(ID_RICHTEXT_CTRL)
-  #   
-  #   attr = Wx::TextAttr.new
-  #   attr.set_flags(Wx::TEXT_ATTR_FONT)
-  #   ctrl.get_style(ctrl.insertion_point, attr)
-  #   
-  #   if attr.has_font? && attr.font.ok?
-  #     currentFontName = attr.font.face_name
-  #   
-  #   # 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.
-  #   
-  #   Wx.SymbolPickerDialog("*", '', currentFontName, self) do |dlg|
-  #   
-  #     if dlg.show_modal == Wx::ID_OK
-  #       if dlg.has_selection?
-  #         insertionPoint = ctrl.insertion_point
-  # 
-  #         ctrl.write_text(dlg.symbol)
-  # 
-  #         unless dlg.use_normal_font
-  #           font = attr.font
-  #           font.face_name = dlg.font_name
-  #           attr.font = font
-  #           ctrl.set_style(insertionPoint, insertionPoint+1, attr)
-  #         end
-  #       end
-  #     end
-  #   end
-  # ```
-  # 
-  # Category:  Common Dialogs
-  # 
-  # @wxrb_require USE_RICHTEXT
-  class SymbolPickerDialog < Dialog
-  
-    # @overload initialize()
-    #   Default ctor.
-    #   @return [Wx::RTC::SymbolPickerDialog]
-    # @overload initialize(symbol, initialFont, normalTextFont, parent, id=Wx::StandardID::ID_ANY, title=(_.new("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 [Wx::RTC::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 [Boolean]
-    def create(symbol, initialFont, normalTextFont, parent, id=Wx::StandardID::ID_ANY, caption=(Wx::GetTranslation.new("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 [Boolean]
-    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 [Boolean]
-    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 [Boolean] 
-    # @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 [Boolean] 
-    # @return [void]
-    def set_unicode_mode(unicodeMode) end
-    alias_method :unicode_mode=, :set_unicode_mode
+  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.
+    # 
+    # ```ruby
+    #   ctrl = find_window(ID_RICHTEXT_CTRL)
+    #   
+    #   attr = Wx::TextAttr.new
+    #   attr.set_flags(Wx::TEXT_ATTR_FONT)
+    #   ctrl.get_style(ctrl.insertion_point, attr)
+    #   
+    #   if attr.has_font? && attr.font.ok?
+    #     currentFontName = attr.font.face_name
+    #   
+    #   # 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.
+    #   
+    #   Wx.SymbolPickerDialog("*", '', currentFontName, self) do |dlg|
+    #   
+    #     if dlg.show_modal == Wx::ID_OK
+    #       if dlg.has_selection?
+    #         insertionPoint = ctrl.insertion_point
+    # 
+    #         ctrl.write_text(dlg.symbol)
+    # 
+    #         unless dlg.use_normal_font
+    #           font = attr.font
+    #           font.face_name = dlg.font_name
+    #           attr.font = font
+    #           ctrl.set_style(insertionPoint, insertionPoint+1, attr)
+    #         end
+    #       end
+    #     end
+    #   end
+    # ```
+    # 
+    # Category:  Common Dialogs
+    # 
+    # @wxrb_require USE_RICHTEXT
+    class SymbolPickerDialog < Dialog
     
-    # Returns true if the has specified normal text - that is, there is no selected font.
-    # @return [Boolean]
-    def use_normal_font; end
+      # @overload initialize()
+      #   Default ctor.
+      #   @return [Wx::RTC::SymbolPickerDialog]
+      # @overload initialize(symbol, initialFont, normalTextFont, parent, id=Wx::StandardID::ID_ANY, title=(_.new("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 [Wx::RTC::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 [Boolean]
+      def create(symbol, initialFont, normalTextFont, parent, id=Wx::StandardID::ID_ANY, caption=(Wx::GetTranslation.new("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 [Boolean]
+      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 [Boolean]
+      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 [Boolean] 
+      # @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 [Boolean] 
+      # @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 [Boolean]
+      def use_normal_font; end
+      
+    end # SymbolPickerDialog
     
-  end # SymbolPickerDialog
-  
 
-end
+    end
+
+  end

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

@@ -144,4 +144,4 @@ module Wx
   end # SashEvent
   
 
-end
+  end

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

@@ -219,4 +219,4 @@ module Wx
   end # LayoutAlgorithm
   
 
-end
+  end

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

@@ -158,4 +158,4 @@ module Wx
   end # SashWindow
   
 
-end
+  end

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

@@ -7,4 +7,4 @@
 module Wx
 
 
-end
+  end

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

@@ -26,4 +26,4 @@ module Wx
   end # ScreenDC
   
 
-end
+  end

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

@@ -70,7 +70,6 @@ module Wx
   # - {Wx::EvtHandler#evt_command_scroll_changed}(meth = nil, &block): Process {Wx::EVT_SCROLL_CHANGED} end of scrolling events (MSW only). 
   # 
   # ## The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
-  # 
   # The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed by an EVT_SCROLL_CHANGED event).
   # The EVT_SCROLL_CHANGED event also occurs when using the keyboard to change the thumb position, and when clicking next to the thumb (In all these cases the EVT_SCROLL_THUMBRELEASE event does not happen).
   # In short, the EVT_SCROLL_CHANGED event is triggered when scrolling/moving has finished independently of the way it had started. Please see the Widgets Sample ("Slider" page) to see the difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
@@ -187,4 +186,4 @@ module Wx
   end # ScrollBar
   
 
-end
+  end

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

@@ -360,4 +360,4 @@ module Wx
   end # ScrolledCanvas
   
 
-end
+  end

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

@@ -360,4 +360,4 @@ module Wx
   end # ScrolledControl
   
 
-end
+  end

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

@@ -380,4 +380,4 @@ module Wx
   end # ScrolledWindow
   
 
-end
+  end

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

@@ -140,4 +140,4 @@ module Wx
   end # SearchCtrl
   
 
-end
+  end

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

@@ -97,4 +97,4 @@ module Wx
   end # Simplebook
   
 
-end
+  end

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

@@ -75,4 +75,4 @@ module Wx
   end # SingleChoiceDialog
   
 
-end
+  end

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

@@ -36,7 +36,6 @@ module Wx
   # Please notice that sizers, like child windows, are owned by the library and will be deleted by it which implies that they must be allocated on the heap. However if you create a sizer and do not add it to another sizer or window, the library wouldn't be able to delete such an orphan sizer and in this, and only this, case it should be deleted explicitly.
   # 
   # ## wxSizer flags
-  # 
   # The "flag" argument accepted by {Wx::SizerItem} constructors and other functions, e.g. {Wx::Sizer#add}, is an OR-combination of the following flags. Two main behaviours are defined using these flags. One is the border around a window: the border parameter determines the border width whereas the flags given here determine which side(s) of the item that the border will be added. The other flags determine how the sizer item behaves when the space allotted to the sizer changes, and is somewhat dependent on the specific kind of sizer used.
   # 
   # {Wx::Direction::TOP}
@@ -926,4 +925,4 @@ module Wx
   end # SizerFlags
   
 
-end
+  end

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

@@ -241,4 +241,4 @@ module Wx
   end # SizerItem
   
 
-end
+  end

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

@@ -132,7 +132,6 @@ module Wx
   # - {Wx::EvtHandler#evt_slider}(id, meth = nil, &block): Process {Wx::EVT_SLIDER} which is generated after any change of {Wx::Slider} position in addition to one of the events above. Notice that the handler of this event receives a {Wx::CommandEvent} as argument and not {Wx::ScrollEvent}, as all the other handlers. 
   # 
   # ## The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
-  # 
   # The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed by an EVT_SCROLL_CHANGED event).
   # The EVT_SCROLL_CHANGED event also occurs when using the keyboard to change the thumb position, and when clicking next to the thumb (In all these cases the EVT_SCROLL_THUMBRELEASE event does not happen). In short, the EVT_SCROLL_CHANGED event is triggered when scrolling/ moving has finished independently of the way it had started. Please see the Widgets Sample ("Slider" page) to see the difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
   # 
@@ -379,4 +378,4 @@ module Wx
   end # Slider
   
 
-end
+  end

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

@@ -141,4 +141,4 @@ module Wx
   end # SpinButton
   
 
-end
+  end

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

@@ -199,4 +199,4 @@ module Wx
   end # SpinCtrl
   
 
-end
+  end

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

@@ -149,4 +149,4 @@ module Wx
   end # SpinCtrlDouble
   
 
-end
+  end

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

@@ -52,4 +52,4 @@ module Wx
   end # SpinDoubleEvent
   
 
-end
+  end

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

@@ -48,4 +48,4 @@ module Wx
   end # SpinEvent
   
 
-end
+  end

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

@@ -64,7 +64,7 @@ module Wx
     # @return [Wx::SplashScreen]
     def initialize(bitmap, splashStyle, milliseconds, parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::Border::BORDER_SIMPLE|Wx::FRAME_NO_TASKBAR|Wx::STAY_ON_TOP)) end
     
-    # Returns the splash style (see {splash_screen} for details).
+    # Returns the splash style (see {Wx::SplashScreen#initialize} for details).
     # @return [Integer]
     def get_splash_style; end
     alias_method :splash_style, :get_splash_style
@@ -87,4 +87,4 @@ module Wx
   end # SplashScreen
   
 
-end
+  end

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

@@ -96,4 +96,4 @@ module Wx
   end # SplitterEvent
   
 
-end
+  end

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

@@ -456,4 +456,4 @@ module Wx
   end # SplitterWindow
   
 
-end
+  end

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

@@ -225,4 +225,4 @@ module Wx
   end # GenericStaticBitmap
   
 
-end
+  end

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

@@ -135,4 +135,4 @@ module Wx
   end # StaticBox
   
 
-end
+  end

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

@@ -69,4 +69,4 @@ module Wx
   end # StaticBoxSizer
   
 
-end
+  end

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

@@ -67,4 +67,4 @@ module Wx
   end # StaticLine
   
 
-end
+  end

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

@@ -105,4 +105,4 @@ module Wx
   end # StaticText
   
 
-end
+  end

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

@@ -262,4 +262,4 @@ module Wx
   end # StatusBarPane
   
 
-end
+  end