wxruby3 0.9.4-x64-mingw-ucrt → 0.9.5-x64-mingw-ucrt

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

@@ -524,19 +524,16 @@ module Wx
   # Note that alignment styles ({Wx::TE_LEFT}, {Wx::TE_CENTRE} and {Wx::TE_RIGHT}) can be changed dynamically after control creation on WXMSW, WXGTK and WXOSX. {Wx::TE_READONLY}, {Wx::TE_PASSWORD} and wrapping styles can be dynamically changed under WXGTK but not WXMSW. The other styles can be only set during control creation.
   # 
   # ## wxTextCtrl Text Format
-  # 
   # The multiline text controls always store the text as a sequence of lines separated by <code>'\n'</code> characters, i.e. in the Unix text format even on non-Unix platforms. This allows the user code to ignore the differences between the platforms but at a price: the indices in the control such as those returned by {Wx::TextCtrl#get_insertion_point} or {Wx::TextCtrl#get_selection} can <b>not</b> be used as indices into the string returned by {Wx::TextCtrl#get_value} as they're going to be slightly off for platforms using <code>"\\r\\n"</code> as separator (as Windows does).
   # Instead, if you need to obtain a substring between the 2 indices obtained from the control with the help of the functions mentioned above, you should use {Wx::TextCtrl#get_range}. And the indices themselves can only be passed to other methods, for example {Wx::TextCtrl#set_insertion_point} or {Wx::TextCtrl#set_selection}.
   # To summarize: never use the indices returned by (multiline) {Wx::TextCtrl} as indices into the string it contains, but only as arguments to be passed back to the other {Wx::TextCtrl} methods. This problem doesn't arise for single-line platforms however where the indices in the control do correspond to the positions in the value string.
   # 
   # ## wxTextCtrl Positions and Coordinates
-  # 
   # It is possible to use either linear positions, i.e. roughly (but not always exactly, as explained in the previous section) the index of the character in the text contained in the control or X-Y coordinates, i.e. column and line of the character when working with this class and it provides the functions {Wx::TextCtrl#position_to_xy} and {Wx::TextCtrl#xy_to_position} to convert between the two.
   # Additionally, a position in the control can be converted to its coordinates in pixels using {Wx::TextCtrl#position_to_coords} which can be useful to e.g. show a popup menu near the given character. And, in the other direction, {Wx::TextCtrl#hit_test} can be used to find the character under, or near, the given pixel coordinates.
   # To be more precise, positions actually refer to the gaps between characters and not the characters themselves. Thus, position 0 is the one before the very first character in the control and so is a valid position even when the control is empty. And if the control contains a single character, it has two valid positions: 0 before this character and 1  after it. This, when the documentation of various functions mentions "invalid position", it doesn't consider the position just after the last character of the line to be invalid, only the positions beyond that one (e.g. 2 and greater in the single character example) are actually invalid.
   # 
   # ## wxTextCtrl Styles.
-  # 
   # Multi-line text controls support styling, i.e. provide a possibility to set colours and font for individual characters in it (note that under Windows {Wx::TE_RICH} style is required for style support). To use the styles you can either call {Wx::TextCtrl#set_default_style} before inserting the text or call {Wx::TextCtrl#set_style} later to change the style of the text already in the control (the first solution is much more efficient).
   # In either case, if the style doesn't specify some of the attributes (for example you only want to set the text colour but without changing the font nor the text background), the values of the default style will be used for them. If there is no default style, the attributes of the text control itself are used.
   # So the following code correctly describes what it does: the second call to {Wx::TextCtrl#set_default_style} doesn't change the text foreground colour (which stays red) while the last one doesn't change the background colour (which stays grey):
@@ -551,7 +548,6 @@ module Wx
   # ```
   # 
   # ## wxTextCtrl and C++ Streams
-  # 
   # This class multiply-inherits from std::streambuf (except for some really old compilers using non-standard iostream library), allowing code such as the following:
   # 
   # ```
@@ -604,7 +600,6 @@ module Wx
   # See {Wx::StreamToTextRedirector} for more details.
   # 
   # ## Event Handling.
-  # 
   # The following commands are processed by default event handlers in {Wx::TextCtrl}: {Wx::StandardID::ID_CUT}, {Wx::StandardID::ID_COPY}, {Wx::StandardID::ID_PASTE}, {Wx::StandardID::ID_UNDO}, {Wx::StandardID::ID_REDO}. The associated UI update events are also processed automatically, when the control has the focus.
   # ### Events emitted by this class
   # 

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

@@ -235,13 +235,11 @@ module Wx
   # A similar control with a fully native implementation for GTK+ and macOS as well is {Wx::DataViewTreeCtrl}.
   # 
   # ## Images in wxTreeCtrl
-  # 
   # {Wx::TreeCtrl} inherits from {Wx::WithImages} classes providing the functions for associating images with the control items. Each item refers to its image using an index, which can possibly by {Wx::WithImages::NO_IMAGE} to indicate that the item doesn't use any image at all, and the corresponding image is taken either from the vector passed to {Wx::WithImages#set_images} or from the image list passed to {Wx::WithImages#set_image_list} or {Wx::WithImages#assign_image_list} functions.
   # In addition to normal images, handled with the methods mentioned above, {Wx::TreeCtrl} also provides optional state images that may be used to indicate some additional state of the item, e.g. checked or unchecked status. These images can be set using {Wx::TreeCtrl#set_state_image_list} and {Wx::TreeCtrl#assign_state_image_list} functions that behave in the same way as the corresponding methods of {Wx::WithImages}.
   # Finally, in the generic version of this control ({Wx::GenericTreeCtrl}), also provides {Wx::TreeCtrl#set_buttons_image_list} and {Wx::TreeCtrl#assign_buttons_image_list}, which can be used to change the images used for the control buttons, used to expand or collapse its branches. These methods are not available in the native WXMSW and {Wx::Qt} implementations.
   # 
   # ## Events
-  # 
   # To intercept events from a tree control, use the event table macros described in {Wx::TreeEvent}.
   # ### Styles
   # 

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

@@ -12,7 +12,6 @@ module Wx
   # To use this class, you need to derive from it and implement the {Wx::VScrolledWindow#on_get_row_height} pure virtual method. You also must call {Wx::VScrolledWindow#set_row_count} to let the base class know how many rows it should display, but from that moment on the scrolling is handled entirely by {Wx::VScrolledWindow}. You only need to draw the visible part of contents in your <code>OnPaint()</code> method as usual. You should use {Wx::VScrolledWindow#get_visible_rows_begin} and {Wx::VScrolledWindow#get_visible_rows_end} to select the lines to display. Note that the device context origin is not shifted so the first visible row always appears at the point (0, 0) in physical as well as logical coordinates.
   # 
   # ## wxWidgets 2.8 Compatibility Functions
-  # 
   # The following functions provide backwards compatibility for applications originally built using {Wx::VScrolledWindow} in 2.6 or 2.8. Originally, {Wx::VScrolledWindow} referred to scrolling "lines". We now use "units" in {Wx::VarScrollHelperBase} to avoid implying any orientation (since the functions are used for both horizontal and vertical scrolling in derived classes). And in the new {Wx::VScrolledWindow} and {Wx::HScrolledWindow} classes, we refer to them as "rows" and "columns", respectively. This is to help clear some confusion in not only those classes, but also in {Wx::HVScrolledWindow} where functions are inherited from both.
   # You are encouraged to update any existing code using these function to use the new replacements mentioned below, and avoid using these functions for any new code as they are deprecated.
   # 

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

@@ -33,7 +33,6 @@ module Wx
   # - {Wx::EvtHandler#evt_wizard_finished}(id, meth = nil, &block): The wizard finished button was pressed. 
   # 
   # ## Extended styles
-  # 
   # Use the {Wx::Window#set_extra_style} function to set the following style. You will need to use two-step construction (use the default constructor, call {Wx::Wizard#set_extra_style}, then call Create).
   # 
   # ### Extra Styles

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

@@ -12,7 +12,6 @@ module Wx
   # This class allows the programmer to decide the order of pages in the wizard dynamically (during run-time) and so provides maximal flexibility. Usually, however, the order of pages is known in advance in which case {Wx::WizardPageSimple} class is enough and it is simpler to use.
   # 
   # ## Virtual functions to override
-  # 
   # To use this class, you must override {Wx::WizardPage#get_prev} and {Wx::WizardPage#get_next} pure virtual functions (or you may use {Wx::WizardPageSimple} instead). {Wx::WizardPage#get_bitmap} can also be overridden, but this should be very rarely needed.
   # 
   # Category:  Miscellaneous Windows

data/lib/wx/doc/owner_drawn_combobox.rb

@@ -7,7 +7,11 @@
 
 module Wx
 
-  class OwnerDrawnComboBox
+  class OwnerDrawnComboBox < ComboCtrl
+
+    alias :get_item_data :get_client_object
+
+    alias :set_item_data :set_client_object
 
     # Returns the label of the selected item or an empty string if no item is selected.
     #

data/lib/wx/version.rb

@@ -3,5 +3,5 @@
 # This software is released under the MIT license.
 
 module Wx
-  WXRUBY_VERSION    = '0.9.4'
+  WXRUBY_VERSION    = '0.9.5'
 end

data/tests/test_combo_ctrl.rb

@@ -0,0 +1,196 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+require_relative './lib/wxframe_runner'
+require_relative './lib/text_entry_tests'
+
+class ComboCtrlCtrlTests < WxRuby::Test::GUITests
+
+  include TextEntryTests
+
+  class LVComboPopup < Wx::ListView
+
+    include Wx::ComboPopup
+
+    def initialize
+      # call default control ctor; need to call Wx::ListView#create later
+      super
+    end
+
+    def init
+      @value = -1
+    end
+
+    def create(parent)
+      # need to finish creating the list view here
+      # as calling super here would just call Wx::ComboPopup#create and not Wx::ListView#create
+      # we need to use Ruby magic
+      wx_lv_create = (Wx::ListView.instance_method :create).bind(self)
+      wx_lv_create.call(parent, 1, [0,0], Wx::DEFAULT_SIZE)
+      evt_motion :on_mouse_move
+      evt_left_up :on_mouse_click
+    end
+    
+    # Return pointer to the created control
+    def get_control
+      self
+    end
+
+    def lv_find_item(*args)
+      unless @wx_lv_find_item
+        @wx_lv_find_item = (Wx::ListView.instance_method :find_item).bind(self)
+      end
+      @wx_lv_find_item.call(*args)
+    end
+    protected :lv_find_item
+
+    # Translate string into a list selection
+    def set_string_value(s)
+      n = lv_find_item(-1, s)
+      if n >= 0 && n < get_item_count
+        select(n)
+        @value = n
+      end
+    end
+ 
+    # Get list selection as a string
+    def get_string_value
+      return get_item_text(@value) if @value >= 0
+      ''
+    end
+ 
+    # Do mouse hot-tracking (which is typical in list popups)
+    def on_mouse_move(event)
+      # Move selection to cursor ...
+    end
+ 
+    # On mouse left up, set the value and close the popup
+    def on_mouse_click(_event)
+      @value = get_first_selected
+ 
+      # Send event as well ...
+ 
+      dismiss
+    end
+
+  end
+
+  def setup
+    super
+    @combo = Wx::ComboCtrl.new(frame_win, name: 'ComboCtrl')
+    @combo.set_popup_control(LVComboPopup.new)
+  end
+
+  def cleanup
+    @combo.destroy
+    super
+  end
+
+  attr_reader :combo
+  alias :text_entry :combo
+
+  def fill_list(list)
+    list.insert_item(0, 'This is the first item')
+    list.insert_item(1, 'This is the second item')
+    list.insert_item(2, 'This is the third item')
+    list.insert_item(3, 'This is the fourth item')
+  end
+
+  def test_popup
+    assert_equal('', combo.get_value)
+
+    assert_kind_of(Wx::ComboPopup, combo.get_popup_control)
+    assert_kind_of(Wx::ListView, combo.get_popup_control)
+    assert_kind_of(Wx::ListView, combo.get_popup_control.get_control)
+
+    assert_nothing_raised { fill_list(combo.get_popup_control) }
+    combo.popup
+
+    combo.set_value_by_user('This is the second item')
+
+    assert_equal('This is the second item', combo.get_popup_control.get_string_value)
+
+    combo.dismiss
+  end
+
+end
+
+class OwnerDrawnCBTests < WxRuby::Test::GUITests
+
+  include TextEntryTests
+
+  class TestODComboBox < Wx::OwnerDrawnComboBox
+
+    def on_draw_item(dc, rect, item, _flags)
+      return if item == Wx::NOT_FOUND
+
+      dc.set_text_foreground(Wx::BLACK)
+      dc.draw_text(get_string(item),
+                   rect.x + 3,
+                   rect.y + ((rect.height - dc.char_height)/2))
+    end
+
+    def on_draw_background(dc, rect, item,  flags)
+      # If item is selected or even, or we are painting the
+      # combo control itself, use the default rendering.
+      if flags.anybits?(Wx::ODCB_PAINTING_CONTROL|Wx::ODCB_PAINTING_SELECTED) || (item & 1) == 0
+        super(dc,rect,item,flags)
+        return
+      end
+
+      # Otherwise, draw every other background with different colour.
+      bgCol = Wx::Colour.new(240,240,250)
+      dc.set_brush(Wx::Brush.new(bgCol))
+      dc.set_pen(Wx::Pen.new(bgCol))
+      dc.draw_rectangle(rect)
+    end
+
+    def on_measure_item(_item)
+      48
+    end
+
+    def on_measure_item_width(_item)
+      -1 # default - will be measured from text width
+    end
+
+  end
+
+  def setup
+    super
+    @combo = TestODComboBox.new(frame_win, name: 'ODComboBox')
+  end
+
+  def cleanup
+    @combo.destroy
+    super
+  end
+
+  attr_reader :combo
+  alias :text_entry :combo
+
+  def fill_list(list)
+    list.append('This is the first item')
+    list.append('This is the second item')
+    list.append('This is the third item')
+    list.append('This is the fourth item')
+  end
+
+  def test_popup
+    assert_equal('', combo.get_value)
+
+    assert_kind_of(Wx::ComboPopup, combo.get_popup_control)
+    assert_kind_of(Wx::ComboPopupWx, combo.get_popup_control)
+    assert_kind_of(Wx::VListBox, combo.get_popup_control.get_control)
+
+    assert_nothing_raised { fill_list(combo) }
+    combo.popup
+
+    combo.set_value_by_user('This is the third item')
+
+    assert_equal('This is the third item', combo.get_popup_control.get_string_value)
+
+    combo.dismiss
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wxruby3
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: x64-mingw-ucrt
 authors:
 - Martin Corino
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-07 00:00:00.000000000 Z
+date: 2024-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -126,6 +126,7 @@ files:
 - lib/wx/core/clipboard.rb
 - lib/wx/core/collapsible_pane.rb
 - lib/wx/core/colour.rb
+- lib/wx/core/combo_ctrl.rb
 - lib/wx/core/combobox.rb
 - lib/wx/core/config.rb
 - lib/wx/core/const.rb
@@ -1053,6 +1054,7 @@ files:
 - tests/test_book_controls.rb
 - tests/test_box_sizer.rb
 - tests/test_clipboard.rb
+- tests/test_combo_ctrl.rb
 - tests/test_config.rb
 - tests/test_dc.rb
 - tests/test_dialog.rb