wxruby3 0.9.0.pre.beta.14-x64-mingw-ucrt → 0.9.0.pre.rc.1-x64-mingw-ucrt

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

@@ -1430,7 +1430,7 @@ module Wx
   
   # Virtual keycodes used by {Wx::KeyEvent} and some other wxWidgets functions.
   # 
-  # Note that the range 0..255 corresponds to the characters of the current locale, in particular the 32..127 subrange is for the ASCII symbols, and all the special key values such as WXK_END lie above this range.
+  # Note that the range 0..255 corresponds to the characters of the current locale, in particular the 32..127 subrange is for the ASCII symbols, and all the special key values such as {Wx::K_END} lie above this range.
   # 
   class KeyCode < Wx::Enum
   
@@ -1598,11 +1598,11 @@ module Wx
     # 
     K_ALT = Wx::KeyCode.new(307)
     
-    # Note that under macOS, to improve compatibility with other systems, 'WXK_CONTROL' represents the 'Command' key.
+    # Note that under macOS, to improve compatibility with other systems, '{Wx::K_CONTROL}' represents the 'Command' key.
     # 
     K_CONTROL = Wx::KeyCode.new(308)
     
-    # Under macOS, where the 'Command' key is mapped to 'Control' to improve compatibility with other systems, WXK_RAW_CONTROL may be used to obtain the state of the actual 'Control' key ('WXK_CONTROL' would obtain the status of the 'Command' key).
+    # Under macOS, where the 'Command' key is mapped to 'Control' to improve compatibility with other systems, {Wx::K_RAW}_CONTROL may be used to obtain the state of the actual 'Control' key ('{Wx::K_CONTROL}' would obtain the status of the 'Command' key).
     # 
     K_RAW_CONTROL = Wx::KeyCode.new(308)
     
@@ -2787,42 +2787,5 @@ module Wx
   # 
   DEFAULT_COORD = -1
   
-  # A function which deletes and nulls the pointer.
-  # This function uses operator delete to free the pointer and also sets it to NULL. Notice that this does not work for arrays, use {deletea} for them.
-  # 
-  #   MyClass *ptr = new MyClass;
-  #   ...
-  #   wxDELETE(ptr);
-  #   wxASSERT(!ptr);
-  # @param ptr [T] 
-  # @return [void]
-  def self.delete(ptr) end
-  
-  # A function which deletes and nulls the pointer.
-  # This function uses vector operator delete (delete[]) to free the array pointer and also sets it to NULL. Notice that this does not work for non-array pointers, use {delete} for them.
-  # 
-  #   MyClass *array = new MyClass[17];
-  #   ...
-  #   wxDELETEA(array);
-  #   wxASSERT(!array);
-  # @see delete
-  # @param array [T] 
-  # @return [void]
-  def self.deletea(array) end
-  
-  # Swaps the contents of two variables.
-  # This is similar to std::swap() but can be used even on the platforms where the standard C++ library is not available (if you don't target such platforms, please use std::swap() instead).
-  # The function relies on type T being copy constructible and assignable.
-  # Example of use: 
-  # 
-  #   int x = 3,
-  #       y = 4;
-  #   wxSwap(x, y);
-  #   wxASSERT( x == 4 && y == 3 );
-  # @param first [T] 
-  # @param second [T] 
-  # @return [void]
-  def self.swap(first, second) end
-  
 
 end

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

@@ -53,28 +53,32 @@ module Wx
   # == Modal and Modeless
   # 
   # There are two kinds of dialog, modal and modeless. A modal dialog blocks program flow and user input on other windows until it is dismissed, whereas a modeless dialog behaves more like a frame in that program flow continues, and input in other windows is still possible. To show a modal dialog you should use the {Wx::Dialog#show_modal} method while to show a dialog modelessly you simply use {Wx::Dialog#show}, just as with frames.
-  # Note that the modal dialog is one of the very few examples of {Wx::Window}-derived objects which may be created on the stack and not on the heap. In other words, while most windows would be created like this:
+  # Note that dialogs need to be explicitly destroyed when closed and not used anymore. The traditional code for this would be like:
   # 
-  #   void AskUser()
-  #   {
-  #       MyAskDialog *dlg = new MyAskDialog(...);
-  #       if ( dlg->ShowModal() == wxID_OK )
-  #           // ...
-  #       //else: dialog was cancelled or some another button pressed
+  # ```ruby
+  #   def ask_user
+  #     dlg = MyAskDialog.new(...)
+  #     if dlg.show_modal == Wx::ID_OK
+  #       # ...
+  #     #else: dialog was cancelled or some another button pressed
+  #     end  
   #   
-  #       dlg->Destroy();
-  #   }
+  #     dlg.destroy
+  #   end
+  # ```
   # 
   # You can achieve the same result with dialogs by using simpler code:
   # 
-  #   void AskUser()
-  #   {
-  #       MyAskDialog dlg(...);
-  #       if ( dlg.ShowModal() == wxID_OK )
-  #           // ...
-  #   
-  #       // no need to call Destroy() here
-  #   }
+  # ```ruby
+  #   def ask_user
+  #     MyAskDialog(...) do |dlg|
+  #       if dlg.show_modal == Wx::ID_OK
+  #         # ...
+  #       #else: dialog was cancelled or some another button pressed
+  #       end  
+  #     end
+  #   end
+  # ```
   # 
   # An application can define a {Wx::CloseEvent} handler for the dialog to respond to system close events.
   # === Styles

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

@@ -40,11 +40,12 @@ module Wx
   # The arguments have the same meaning as those of {Wx::DirDialog#initialize}. The message is displayed at the top, and the default_path, if specified, is set as the initial selection.
   # The application must check for an empty return value (if the user pressed Cancel). For example:
   # 
-  #   const wxString& dir = wxDirSelector("Choose a folder");
-  #   if ( !dir.empty() )
-  #   {
-  #       ...
-  #   }
+  # ```ruby
+  #   dir = Wx.dir_selector('Choose a folder')
+  #   unless dir.empty?
+  #     ...
+  #   end
+  # ```
   # @param message [String] 
   # @param default_path [String] 
   # @param style [Integer] 
@@ -65,9 +66,10 @@ module Wx
   # - {Wx::DD_SHOW_HIDDEN}: Show hidden and system folders. This flag is only available since wxWidgets 3.1.4 
   # 
   # Notice that {Wx::RESIZE_BORDER} has special side effect under Windows where two different directory selection dialogs are available and this style also implicitly selects the new version as the old one always has fixed size. As the new version is almost always preferable, it is recommended that {Wx::RESIZE_BORDER} style be always used. This is the case if the dialog is created with the default style value but if you need to use any additional styles you should still specify {Wx::DD_DEFAULT_STYLE} unless you explicitly need to use the old dialog version under Windows. E.g. do 
-  # 
-  #   wxDirDialog dlg(NULL, "Choose input directory", "",
-  #                   wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST);
+  # ```ruby
+  #   Wx::DirDialog(nil, 'Choose input directory', '',
+  #                 Wx::DD_DEFAULT_STYLE | Wx::DD_DIR_MUST_EXIST)  
+  # ```
   #  instead of just using {Wx::DD_DIR_MUST_EXIST} style alone.
   # MacOS 10.11+ does not display a title bar on the dialog. Use {Wx::DirDialog#set_message} to change the string displayed to the user at the top of the dialog after creation. The {Wx::DirDialog#set_title} method is provided for compatibility with pre-10.11 MacOS versions that do still support displaying the title bar.
   # 

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

@@ -80,7 +80,7 @@ module Wx
     # 
     K_CATEGORY_CUT = Wx::KeyCategoryFlags.new(16)
     
-    # union of WXK_CATEGORY_ARROW, WXK_CATEGORY_PAGING, and WXK_CATEGORY_JUMP categories
+    # union of {Wx::K_CATEGORY}_ARROW, {Wx::K_CATEGORY}_PAGING, and {Wx::K_CATEGORY}_JUMP categories
     # 
     K_CATEGORY_NAVIGATION = Wx::KeyCategoryFlags.new(7)
     
@@ -697,7 +697,7 @@ module Wx
   # An event is a structure holding information about an event passed to a callback or member function.
   # {Wx::Event} used to be a multipurpose event object, and is an abstract base class for other event classes (see below).
   # For more information about events, see the Events and Event Handling overview.
-  # <b>{Wx::Perl} Note:</b> In {Wx::Perl} custom event classes should be derived from Wx::PlEvent and Wx::PlCommandEvent. 
+  # 
   # === 
   # 
   # Category:  {Wx::Events}

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

@@ -0,0 +1,49 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This class is a special event handler which allows discarding any event (or a set of event types) directed to a specific window.
+  # Example:
+  # 
+  # ```
+  #   void MyWindow::DoSomething()
+  #   {
+  #       {
+  #           // block all events directed to this window while
+  #           // we do the 1000 FunctionWhichSendsEvents() calls
+  #           wxEventBlocker blocker(this);
+  #   
+  #           for ( int i = 0; i  1000; i++ )
+  #               FunctionWhichSendsEvents(i);
+  #   
+  #       } // ~wxEventBlocker called, old event handler is restored
+  #   
+  #       // the event generated by this call will be processed:
+  #       FunctionWhichSendsEvents(0)
+  #   }
+  # ```
+  # 
+  # === 
+  # 
+  # Category:  {Wx::Events}
+  # @see How Events are Processed
+  # @see  Wx::EvtHandler 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class EventBlocker < EvtHandler
+  
+    # Adds to the list of event types which should be blocked the given eventType.
+    # @param eventType [Integer] 
+    # @return [void]
+    def block(eventType) end
+    
+  end # EventBlocker
+  
+
+end

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

@@ -0,0 +1,95 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A global event filter for pre-processing all the events generated in the program.
+  # This is a very simple class which just provides {Wx::EventFilter#filter_event} virtual method to be called by {Wx::EvtHandler} before starting process of any event. Thus, inheriting from this class and overriding {Wx::EventFilter#filter_event} allows capturing and possibly handling or ignoring all the events happening in the program. Of course, having event filters adds additional overhead to every event processing and so should not be used lightly and your {Wx::EventFilter#filter_event} code should try to return as quickly as possible, especially for the events it is not interested in.
+  # An example of using this class: 
+  # ```
+  #   // This class allows determining the last time the user has worked with
+  #   // this application:
+  #   class LastActivityTimeDetector : public wxEventFilter
+  #   {
+  #   public:
+  #       LastActivityTimeDetector()
+  #       {
+  #           wxEvtHandler::AddFilter(this);
+  #   
+  #           m_last = wxDateTime::Now();
+  #       }
+  #   
+  #       virtual ~LastActivityTimeDetector()
+  #       {
+  #           wxEvtHandler::RemoveFilter(this);
+  #       }
+  #   
+  #       virtual int FilterEvent(wxEvent& event)
+  #       {
+  #           // Update the last user activity
+  #           const wxEventType t = event.GetEventType();
+  #           if ( t == wxEVT_KEY_DOWN || t == wxEVT_MOTION ||
+  #                   t == wxEVT_LEFT_DOWN ||
+  #                       t == wxEVT_RIGHT_DOWN ||
+  #                           t == wxEVT_MIDDLE_DOWN )
+  #           {
+  #               m_last = wxDateTime::Now();
+  #           }
+  #   
+  #           // Continue processing the event normally as well.
+  #           return Event_Skip;
+  #       }
+  #   
+  #       // This function could be called periodically from some timer to
+  #       // do something (e.g. hide sensitive data or log out from remote
+  #       // server) if the user has been inactive for some time period.
+  #       bool IsInactiveFor(const wxTimeSpan& diff) const
+  #       {
+  #           return wxDateTime::Now() - diff > m_last;
+  #       }
+  #   
+  #   private:
+  #       wxDateTime m_last;
+  #   };
+  # ```
+  # 
+  # Notice that {Wx::App} derives from {Wx::EventFilter} and is registered as an event filter during its creation so you may also override {Wx::EventFilter#filter_event} method in your {Wx::App}-derived class and, in fact, this is often the most convenient way to do it. However creating a new class deriving directly from {Wx::EventFilter} allows isolating the event filtering code in its own separate class and also having several independent filters, if necessary.
+  # Category:  {Wx::Events}
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class EventFilter < ::Object
+  
+    # Process event as usual.
+    # 
+    Event_Skip = -1
+    
+    # Don't process the event normally at all.
+    # 
+    Event_Ignore = 0
+    
+    # Event was already handled, don't process it normally.
+    # 
+    Event_Processed = 1
+    
+    # Default constructor.
+    # Constructor does not register this filter using {Wx::EvtHandler.add_filter}, it's your responsibility to do it when necessary.
+    # Notice that the objects of this class can't be copied.
+    # @return [EventFilter]
+    def initialize; end
+    
+    # Override this method to implement event pre-processing.
+    # This method allows filtering all the events processed by the program, so you should try to return quickly from it to avoid slowing down the program to a crawl.
+    # Although the return type of this method is int, this is only due to backwards compatibility concerns and the actual return value must be one of the Event_XXX constants defined above:
+    # - Event_Skip to continue processing the event normally (this should be used in most cases).- Event_Ignore to not process this event at all (this can be used to suppress some events).- Event_Processed to not process this event normally but indicate that it was already processed by the event filter and so no default processing should take place either (this should only be used if the filter really did process the event).
+    # @param event [Wx::Event] 
+    # @return [Integer]
+    def filter_event(event) end
+    
+  end # EventFilter
+  
+
+end

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

@@ -1130,7 +1130,7 @@ class Wx::EvtHandler
   # @yieldparam [Wx::CommandEvent] event the event to handle
   def evt_choice(id, meth = nil, &block) end
   
-  # Process a {Wx::EVT_COMBOBOX} event, when an item on the list is selected. Note that calling {Wx::ComboBox#get_value} returns the new value of selection. 
+  # Process a {Wx::EVT_COMBOBOX} event, when an item on the list is selected. 
   # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
   # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
   # @yieldparam [Wx::CommandEvent] event the event to handle
@@ -1199,7 +1199,7 @@ class Wx::EvtHandler
   # @yieldparam [Wx::CommandEvent] event the event to handle
   def evt_text(id, meth = nil, &block) end
   
-  # Process a {Wx::EVT_TEXT_ENTER} event, when RETURN is pressed in the combobox (notice that the combobox must have been created with {Wx::TE_PROCESS_ENTER} style to receive this event). 
+  # Process a {Wx::EVT_TEXT_ENTER} event, when RETURN is pressed in the combobox. 
   # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
   # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
   # @yieldparam [Wx::CommandEvent] event the event to handle
@@ -1330,6 +1330,20 @@ class Wx::EvtHandler
   # @yieldparam [Wx::BookCtrlEvent] event the event to handle
   def evt_notebook_page_changing(id, meth = nil, &block) end
   
+  # Respond to a {Wx::EVT_SEARCH} event, generated when the search button is clicked. Note that this does not initiate a search on its own, you need to perform the appropriate action in your event handler. You may use 
+  # Processes a {Wx::EVT_SEARCH} event.
+  # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+  # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+  # @yieldparam [Wx::CommandEvent] event the event to handle
+  def evt_search(id, meth = nil, &block) end
+  
+  # Respond to a {Wx::EVT_SEARCH_CANCEL} event, generated when the cancel button is clicked. 
+  # Processes a {Wx::EVT_SEARCH_CANCEL} event.
+  # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+  # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+  # @yieldparam [Wx::CommandEvent] event the event to handle
+  def evt_search_cancel(id, meth = nil, &block) end
+  
   # Process a {Wx::EVT_SPINCTRL} event, which is generated whenever the numeric value of the spin control is updated. 
   # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
   # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc