wxruby3 0.9.0.pre.rc.3 → 0.9.1

data/lib/wx/doc/const.rb

@@ -1,77 +1,84 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
 module Wx
 
 =begin
   These constants are not documented in the wxWidgets interface headers
   although they are referenced in various argument defaults which *are*
   in the interface header declarations so we do want them included the
-  wxRuby docs so the doc links work but we do not need them in the
-  wxRuby implementation since these are internal to the C++ wrappers.
+  wxRuby docs so the doc links work.
 =end
 
-  DefaultDateTimeFormat = '%c'
-  DefaultTimeSpanFormat = '%H:%M:%S'
+  DEFAULT_DATE_TIME_FORMAT = '%c'
+  DEFAULT_TIME_SPAN_FORMAT = '%H:%M:%S'
+
+  CHOICE_NAME_STR = 'choice'
+  COLOUR_PICKER_CTRL_NAME_STR = 'colourpicker'
+  COLOUR_PICKER_WIDGET_NAME_STR = 'colourpickerwidget'
+  HYPERLINK_CTRL_NAME_STR = 'hyperlink'
+  PANEL_NAME_STR = 'panel'
+  LIST_BOX_NAME_STR = 'listBox'
+  FRAME_NAME_STR = 'frame'
+  STATUS_LINE_NAME_STR = 'status_line'
+  STATIC_BITMAP_NAME_STR = 'staticBitmap'
+  WEB_VIEW_NAME_STR = 'wxWebView'
+  ANIMATION_CTRL_NAME_STR = 'animationctrl'
+  TOOL_BAR_NAME_STR = 'toolbar'
+  TEXT_CTRL_NAME_STR = 'text'
+  LIST_CTRL_NAME_STR = 'listCtrl'
+  FILE_PICKER_CTRL_NAME_STR = 'filepicker'
+  FILE_PICKER_WIDGET_NAME_STR = 'filepickerwidget'
+  DIR_PICKER_CTRL_NAME_STR = 'dirpicker'
+  DIR_PICKER_WIDGET_NAME_STR = 'dirpickerwidget'
+  FILE_CTRL_NAME_STR = 'wxfilectrl'
+  FILE_SELECTOR_PROMPT_STR = 'Select a file'
+  STATIC_BOX_NAME_STR = 'groupBox'
+  BUTTON_NAME_STR = 'button'
+  RADIO_BOX_NAME_STR = 'radioBox'
+  STATIC_LINE_NAME_STR = 'staticLine'
+  RADIO_BUTTON_NAME_STR = 'radioButton'
+  BITMAP_RADIO_BUTTON_NAME_STR = 'radioButton'
+  GAUGE_NAME_STR = 'gauge'
+  DATA_VIEW_CTRL_NAME_STR = 'dataviewCtrl'
+  FONT_PICKER_CTRL_NAME_STR = 'fontpicker'
+  FONT_PICKER_WIDGET_NAME_STR = 'fontpickerwidget'
+  REARRANGE_LIST_NAME_STR = 'wxRearrangeList'
+  REARRANGE_DIALOG_NAME_STR = 'wxRearrangeDlg'
+  NOTEBOOK_NAME_STR = 'notebook'
+  CONTROL_NAME_STR = 'control'
+  SCROLL_BAR_NAME_STR = 'scrollBar'
+  STATUS_BAR_NAME_STR = 'statusBar'
+  SLIDER_NAME_STR = 'slider'
+  HEADER_CTRL_NAME_STR = 'wxHeaderCtrl'
+  BITMAP_COMBO_BOX_NAME_STR = 'bitmapComboBox'
+  CHECK_BOX_NAME_STR = 'check'
+  FILE_DIALOG_NAME_STR = 'filedlg'
+  ADD_REMOVE_CTRL_NAME_STR = 'wxAddRemoveCtrl'
+  STATIC_TEXT_NAME_STR = 'staticText'
+  COMBO_BOX_NAME_STR = 'comboBox'
+  SEARCH_CTRL_NAME_STR = 'searchCtrl'
+  TREE_CTRL_NAME_STR = 'treeCtrl'
+  DIALOG_NAME_STR = 'dialog'
+  COLLAPSIBLE_HEADER_CTRL_NAME_STR = 'collapsibleHeader'
+  COLLAPSIBLE_PANE_NAME_STR = 'collapsiblePane'
+  BANNER_WINDOW_NAME_STR = 'bannerwindow'
+  GRID_NAME_STR = 'grid'
+  TREE_LIST_CTRL_NAME_STR = 'wxTreeListCtrl'
+  HTML_LIST_BOX_NAME_STR = 'htmlListBox'
+  SIMPLE_HTML_LIST_BOX_NAME_STR = 'simpleHtmlListBox'
+  EDITABLE_LIST_BOX_NAME_STR = 'editableListBox'
+  V_LIST_BOX_NAME_STR = 'wxVListBox'
+
+  # wxMSW only
+  MSW_HEADER_CTRL_NAME_STR = 'wxMSWHeaderCtrl'
 
-  ChoiceNameStr = 'choice'
-  ColourPickerCtrlNameStr = 'colourpicker'
-  ColourPickerWidgetNameStr = 'colourpickerwidget'
-  HyperlinkCtrlNameStr = 'hyperlink'
-  PanelNameStr = 'panel'
-  ListBoxNameStr = 'listBox'
-  FrameNameStr = 'frame'
-  StatusLineNameStr = 'status_line'
-  StaticBitmapNameStr = 'staticBitmap'
-  WebViewNameStr = 'wxWebView'
-  AnimationCtrlNameStr = 'animationctrl'
-  ToolBarNameStr = 'toolbar'
-  TextCtrlNameStr = 'text'
-  ListCtrlNameStr = 'listCtrl'
-  FilePickerCtrlNameStr = 'filepicker'
-  FilePickerWidgetNameStr = 'filepickerwidget'
-  DirPickerCtrlNameStr = 'dirpicker'
-  DirPickerWidgetNameStr = 'dirpickerwidget'
-  FileCtrlNameStr = 'wxfilectrl'
-  StaticBoxNameStr = 'groupBox'
-  ButtonNameStr = 'button'
-  RadioBoxNameStr = 'radioBox'
-  StaticLineNameStr = 'staticLine'
-  RadioButtonNameStr = 'radioButton'
-  BitmapRadioButtonNameStr = 'radioButton'
-  GaugeNameStr = 'gauge'
-  DataViewCtrlNameStr = 'dataviewCtrl'
-  FontPickerCtrlNameStr = 'fontpicker'
-  FontPickerWidgetNameStr = 'fontpickerwidget'
-  RearrangeListNameStr = 'wxRearrangeList'
-  RearrangeDialogNameStr = 'wxRearrangeDlg'
-  NotebookNameStr = 'notebook'
-  ControlNameStr = 'control'
-  ScrollBarNameStr = 'scrollBar'
-  StatusBarNameStr = 'statusBar'
-  SliderNameStr = 'slider'
-  HeaderCtrlNameStr = 'wxHeaderCtrl'
-  BitmapComboBoxNameStr = 'bitmapComboBox'
-  CheckBoxNameStr = 'check'
-  FileDialogNameStr = 'filedlg'
-  AddRemoveCtrlNameStr = 'wxAddRemoveCtrl'
-  StaticTextNameStr = 'staticText'
-  ComboBoxNameStr = 'comboBox'
-  SearchCtrlNameStr = 'searchCtrl'
-  DirDialogNameStr = 'wxDirCtrl'
-  TreeCtrlNameStr = 'treeCtrl'
-  DialogNameStr = 'dialog'
-  CollapsibleHeaderCtrlNameStr = 'collapsibleHeader'
-  CollapsiblePaneNameStr = 'collapsiblePane'
-  BannerWindowNameStr = 'bannerwindow'
-  GridNameStr = 'grid'
-  TreeListCtrlNameStr = 'wxTreeListCtrl'
-  HtmlListBoxNameStr = 'htmlListBox'
-  SimpleHtmlListBoxNameStr = 'simpleHtmlListBox'
-  EditableListBoxNameStr = 'editableListBox'
-  VListBoxNameStr = 'wxVListBox'
-  CollapsiblePaneNameStr = 'collapsiblePane'
-  MSWHeaderCtrlNameStr = 'wxMSWHeaderCtrl'
-  PropertyGridManagerNameStr = 'wxPropertyGridManager'
-  PropertyGridNameStr = 'wxPropertyGrid'
-  STCNameStr = 'stcwindow'
-  STCNameStr = 'stcwindow'
+  PROPERTY_GRID_MANAGER_NAME_STR = 'wxPropertyGridManager'
+  PROPERTY_GRID_NAME_STR = 'wxPropertyGrid'
+  STC_NAME_STR = 'stcwindow'
 
 end

data/lib/wx/doc/controlwithitems.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 class Wx::ControlWithItems
 

data/lib/wx/doc/core.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/cursor.rb

@@ -1,16 +1,24 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
 
-class Wx::Cursor
+
+class Wx
 
   # Searches for an art file with basename 'name' and creates a Cursor if found.
   # Raises an ArgumentError if not found.
   # Wx::ArtLocator::find_art is used to look up the art file using ::Kernel#caller_locations to
-  # determine the values for the 'art_path' and 'art_owner' arguments ('art_path' is set to the
-  # absolute path to the folder holding the caller's code and 'art_owner' to the basename of the
-  # caller's source file). The 'art_type' argument is set to <code>:icon</code>.
+  # determine the values for the 'art_path' and 'art_section' arguments if not specified here
+  # ('art_path' is set to the absolute path to the folder holding the caller's code and 'art_section'
+  # to the basename of the caller's source file). The 'art_type' argument is set to <code>:cursor</code>.
   # @param [String,Symbol] name base name of art file
   # @param [Wx::BitmapType,nil] bmp_type bitmap type for art file (nil means any supported type)
+  # @param [String,nil] art_path base path to look up the art file
+  # @param [String,nil] art_section optional owner folder name for art files
   # @return [Wx::Cursor]
   # @see Wx::ArtLocator::find_art
-  def self.Cursor(name, bmp_type = nil); end
+  def self.Cursor(name, bmp_type = nil, art_path: nil, art_section: nil); end
 
 end

data/lib/wx/doc/data_object.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/datetime.rb

@@ -0,0 +1,16 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  # Default/Null time (mostly equates to `now`).
+  DEFAULT_DATE_TIME = nil
+
+  # Default/Null time (mostly equates to `now`).
+  DefaultDateTime = DEFAULT_DATE_TIME
+
+end

data/lib/wx/doc/dc.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
   class DC

data/lib/wx/doc/enum.rb

@@ -1,7 +1,14 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+
 ###
 # wxRuby3 Enum class
-# Copyright (c) M.J.N. Corino, The Netherlands
 ###
+# :startdoc:
+
 
 
 module Wx

data/lib/wx/doc/event.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/event_blocker.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/event_loop.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/events.rb

@@ -1,3 +1,9 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
 
 module Wx
 

data/lib/wx/doc/evthandler.rb

@@ -1,4 +1,12 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+
 # Additional event handler methods documentation stubs.
+# :startdoc:
+
 
 
 class Wx::EvtHandler

data/lib/wx/doc/extra/01_packages.md

@@ -56,117 +56,118 @@ Currently the following modules have been implemented.
 
 ### Core
 
-The core wxRuby package providing the toplevel `Wx` module.
+The core wxRuby package providing the toplevel {Wx} module.
 This package includes basic classes like:
 
-- `Wx::Object`
-- `Wx::EvtHandler`
-- `Wx::Event`
-- `Wx::CommandEvent`
-- `Wx::App`
-- `Wx::Window`
-- `Wx::NonOwnedWindow`
-- `Wx::ToplevelWindow`
-- `Wx::Frame`
-- `Wx::Dialog`
+- {Wx::Object}
+- {Wx::EvtHandler}
+- {Wx::Event}
+- {Wx::CommandEvent}
+- {Wx::App}
+- {Wx::Window}
+- {Wx::NonOwnedWindow}
+- {Wx::TopLevelWindow}
+- {Wx::Frame}
+- {Wx::Dialog}
 
 as well as most common window classes, control/widget classes, event classes, constant and enum definitions
 and global functions not part of any of the other packages.
 
 ### AUI - Advanced User Interface controls and related classes
 
-The wxRuby AUI package providing the `Wx::AUI` module.
+The wxRuby AUI package providing the {Wx::AUI} module.
 This package includes all classes, constants and enum definitions that are considered part of the 
 wxWidgets AUI framework like:
 
-- `Wx::AUI::AuiManager`
-- `Wx::AUI::AuiMDIParentFrame`
-- `Wx::AUI::AuiMDIChildFrame`
-- `Wx::AUI::AuiMDIClientWindow`
+- {Wx::AUI::AuiManager}
+- {Wx::AUI::AuiMDIParentFrame}
+- {Wx::AUI::AuiMDIChildFrame}
+- {Wx::AUI::AuiMDIClientWindow}
 - etc
 
 ### GRID - Grid control and related classes
 
-The wxRuby GRID package providing the `Wx::GRID` module.
+The wxRuby GRID package providing the {Wx::GRID} module.
 This package includes all classes, constants and enum definitions that are associated with the
 wxWidgets wxGrid control like:
 
-- `Wx::GRID::Grid`
-- `Wx::GRID::GridTableBase`
-- `Wx::GRID::GridCellEditor`
-- `Wx::GRID::GridCellRenderer`
-- `Wx::GRID::GridEvent`
+- {Wx::GRID::Grid}
+- {Wx::GRID::GridTableBase}
+- {Wx::GRID::GridCellEditor}
+- {Wx::GRID::GridCellRenderer}
+- {Wx::GRID::GridEvent}
 - etc
 
 ### HTML - Html framework classes
 
-The wxRuby HTML package providing the `Wx::HTML` module.
+The wxRuby HTML package providing the {Wx::HTML} module.
 This package includes all classes, constants and enum definitions that are considered part of the
 wxWidgets Html framework like:
 
-- `Wx::HTML::HtmlWindow`
-- `Wx::HTML::HtmlHelpWindow`
-- `Wx::HTML::HtmlHelpFrame`
-- `Wx::HTML::HtmlHelpController`
+- {Wx::HTML::HtmlWindow}
+- {Wx::HTML::HtmlHelpWindow}
+- {Wx::HTML::HtmlPrintout}
+- {Wx::HTML::HtmlHelpController}
+- {Wx::HTML::HtmlListBox}
 - etc
 
 ### PG - PropertyGrid control and related classes
 
-The wxRuby PG package providing the `Wx::PG` module.
+The wxRuby PG package providing the {Wx::PG} module.
 This package includes all classes, constants and enum definitions that are associated with the
 wxWidgets wxPropertyGrid control like:
 
-- `Wx::PG::PropertyGrid`
-- `Wx::PG::PropertyGridManager`
-- `Wx::PG::PGCell`
-- `Wx::PG::PGProperty`
-- `Wx::PG::PropertyGridEvent`
+- {Wx::PG::PropertyGrid}
+- {Wx::PG::PropertyGridManager}
+- {Wx::PG::PGCell}
+- {Wx::PG::PGProperty}
+- {Wx::PG::PropertyGridEvent}
 - etc
 
 ### PRT - Printing framework classes
 
-The wxRuby PRT package providing the `Wx::PRT` module.
+The wxRuby PRT package providing the {Wx::PRT} module.
 This package includes all classes, constants and enum definitions that are considered part of the
 wxWidgets Printing framework like:
 
-- `Wx::PRT::PreviewFrame`
-- `Wx::PRT::Printer`
-- `Wx::PRT::PrinterDC`
-- `Wx::PRT::PrintDialog`
+- {Wx::PRT::PreviewFrame}
+- {Wx::PRT::Printer}
+- {Wx::PRT::PrinterDC}
+- {Wx::PRT::PrintDialog}
 - etc
 
 ### RBN - Ribbon framework classes
 
-The wxRuby RBN package providing the `Wx::RBN` module.
+The wxRuby RBN package providing the {Wx::RBN} module.
 This package includes all classes, constants and enum definitions that are considered part of the
 wxWidgets Ribbon framework like:
 
-- `Wx::RBN::RibbonControl`
-- `Wx::RBN::RibbonGallery`
-- `Wx::RBN::RibbonPanel`
-- `Wx::RBN::RibbonPage`
-- `Wx::RBN::RibbonBar`
+- {Wx::RBN::RibbonControl}
+- {Wx::RBN::RibbonGallery}
+- {Wx::RBN::RibbonPanel}
+- {Wx::RBN::RibbonPage}
+- {Wx::RBN::RibbonBar}
 - etc
 
 ### RTC - RichText control and related classes
 
-The wxRuby RTC package providing the `Wx::RTC` module.
+The wxRuby RTC package providing the {Wx::RTC} module.
 This package includes all classes, constants and enum definitions that are associated with the
 wxWidgets wxRichTextCtrl control like:
 
-- `Wx::RTC::RichTextCtrl`
-- `Wx::RTC::RichTextEvent`
-- `Wx::RTC::RichTextBuffer`
+- {Wx::RTC::RichTextCtrl}
+- {Wx::RTC::RichTextEvent}
+- {Wx::RTC::RichTextBuffer}
 - etc
 
 ### STC - StyledText control and related classes
 
-The wxRuby STC package providing the `Wx::STC` module.
+The wxRuby STC package providing the {Wx::STC} module.
 This package includes all classes, constants and enum definitions that are associated with the
 wxWidgets wxStyledTextCtrl control (Scintilla integration) like:
 
-- `Wx::STC::StyledTextCtrl`
-- `Wx::STC::StyledTextEvent`
+- {Wx::STC::StyledTextCtrl}
+- {Wx::STC::StyledTextEvent}
 
 ## Feature dependencies
 

data/lib/wx/doc/extra/05_event-handling.md

@@ -15,8 +15,9 @@ Instead wxRuby offers a dynamic solution that is just as easy to use and even of
 ## Event handlers
 
 Instead of the `EVT_XXX` event handler declaration macros used in wxWidgets wxRuby provides similarly named event handler 
-definition methods for each of the known event declarations which are inherited by **all** classes derived from `Wx::EvtHandler`
-(which includes all window classes, the `Wx::App` class and `Wx::Timer` as well as various other classes).<br>
+definition methods for each of the known event declarations which are inherited by **all** classes derived from {Wx::
+EvtHandler}
+(which includes all window classes, the {Wx::App} class and {Wx::Timer} as well as various other classes).<br>
 
 Naming is (mostly) identical but rubified. So `EVT_MENU` becomes `evt_menu`, `EVT_IDLE` becomes `evt_idle`, `EVT_UPDATE_UI`
 becomes `evt_update_ui` etc.
@@ -27,7 +28,7 @@ Like the event handler macros some of these methods require a single (window) id
 
 Event handler setup is typically something done during the initialization of an event handler object (like a window) but
 this is not required. As all event handlers are assigned dynamically in wxRuby you can setup (some) event handlers at a 
-later moment. You could also disconnect earlier activated handlers at any time (see `Wx::EvtHandler#disconnect`).
+later moment. You could also disconnect earlier activated handlers at any time (see {Wx::EvtHandler#disconnect}).
 
 In case of some frame class `MyForm` including a menu a wxWidgets static event handling table like:
 
@@ -96,7 +97,7 @@ will take care of checking and handling method arity.
 
 Custom event definitions are fully supported in wxRuby including the definition of new event types.
 
-New event classes can be registered with `Wx::EvtHandler#register_class` which returns the new event type for the event 
+New event classes can be registered with {Wx::EvtHandler#register_class} which returns the new event type for the event 
 class like this:
 
 ```ruby
@@ -125,27 +126,27 @@ Check the reference documentation [here](https://mcorino.github.io/wxRuby3/Wx/Ev
 
 ## Event processing
 
-In wxRuby overruling the normal chain of event handling has been limited to being able to override the default 
-`Wx::EvtHandler#try_before` and `Wx::EvtHandler#try_after` methods. These are the advised interception points for events
+In wxRuby overruling the normal chain of event handling has been limited to being able to override the default
+{Wx::EvtHandler#try_before} and {Wx::EvtHandler#try_after} methods. These are the advised interception points for events
 when you really need to do this.<br>
-Overriding `Wx::EvtHandler#process_event` is not considered to be efficient (or desired)
+Overriding {Wx::EvtHandler#process_event} is not considered to be efficient (or desired)
 for wxRuby applications and has therefor been blocked.
 
 ## Event insertion
 
-Use of `Wx::EvtHandler#process_event` or `Wx::EvtHandler#queue_event` and `Wx::EvtHandler#add_pending_event` in wxRuby to
+Use of {Wx::EvtHandler#process_event} or {Wx::EvtHandler#queue_event} and {Wx::EvtHandler#add_pending_event} in wxRuby to
 trigger event processing of user generated (possibly custom) events is fully supported.
 
-As with wxWidgets `Wx::EvtHandler#process_event` will trigger immediate processing of the given event, not returning before
+As with wxWidgets {Wx::EvtHandler#process_event} will trigger immediate processing of the given event, not returning before
 this has finished.<br>
-`Wx::EvtHandler#queue_event` and `Wx::EvtHandler#add_pending_event` on the other hand will post (append) the given event
+{Wx::EvtHandler#queue_event} and {Wx::EvtHandler#add_pending_event} on the other hand will post (append) the given event
 to the event queue and return immediately after that is done. The event will than be processed after any other events in
 the queue. Unlike in wxWidgets in wxRuby there is no practical difference between `queue_event` and `add_pending_event`.
 
 ## Asynchronous execution
 
-In addition to `Wx::EvtHandler#queue_event` and `Wx::EvtHandler#add_pending_event` to trigger asynchronous processing 
-wxRuby also supports `Wx::EvtHandler#call_after`.
+In addition to {Wx::EvtHandler#queue_event} and {Wx::EvtHandler#add_pending_event} to trigger asynchronous processing 
+wxRuby also supports {Wx::EvtHandler#call_after}.
 
 This method provides the means to trigger asynchronous execution of arbitrary code and because it has been rubified is
 easy and powerful to use. Like with event handler definition this method accepts a `Symbol` or `String` (identifying a 
@@ -164,3 +165,27 @@ evt_handler.call_after(->(txt) { Wx.log_info(txt) }, "Hello")
 # async call of block
 evt_handler.call_after('Call nr. %d', 1) { |fmt, num| Wx.log_info(fmt, num) }
 ```
+
+## Event life cycles!
+
+Like in C++ the wxRuby Event objects passed to the event handlers are (in general) references to **temporary** objects 
+which are only safe to access within the execution scope of the event handler that received the reference.
+If you *need* (really?) to store a reference to such an object do so to a cloned version (see {Wx::Event#clone}) and **not**
+to the original object otherwise you **will** run into 'Object already deleted' exceptions.
+
+Only user defined events instantiated in Ruby code (or cloned Event objects) will be subject to Ruby's normal life cycle 
+rules (GC).
+This means that when you instantiate a user defined event and pass it to {Wx::EvtHandler#process_event} it would be possible
+to directly store the reference to such an Event object passed to it's event handler. You have to **know** for sure though
+(see below). So, in case of doubt (or to be safe) use {Wx::Event#clone}.
+
+Another 'feature' to be aware of is the fact that when passing an (user instantiated) Event object to {Wx::
+EvtHandler#queue_event} 
+or {Wx::EvtHandler#add_pending_event} the Ruby event instance is unlinked from it's C++ counterpart (or in the case of user
+defined events a cloned instance is associated with it's C++ counterpart) before being queued and the C++ side now takes ownership 
+(and will delete the Event object when handled).  
+As a result this means that even in the case of a user defined Event object any event handler triggered by a asynchronously 
+processed event will be handling a temporary Event object.
+Additionally this also means that any Event object passed to {Wx::EvtHandler#queue_event} or {Wx::
+EvtHandler#add_pending_event}
+is essentially invalidated after these methods return and should not be referenced anymore.

data/lib/wx/doc/extra/06_geometry.md

@@ -19,13 +19,13 @@ Wx::Frame.new(nil, -1, 'title', Wx::Point.new(0,0), Wx::Size.new(500,400))
 which starts to feel awkward to specify what are in essence just pairs of integers.
 
 To provide a simpler, more compact and more Ruby-like, alternative the wxRuby API therefor supports specifying arrays
-of integer (or float in case of Wx::RealPoint) pairs in (almost) all cases where `Wx::Size` or `Wx::Point` 
-(or Wx::RealPoint) is expected. So the following code is equivalent to the previous code:
+of integer (or float in case of {Wx::RealPoint}) pairs in (almost) all cases where {Wx::Size} or {Wx::Point} 
+(or {Wx::RealPoint}) is expected. So the following code is equivalent to the previous code:
 ```ruby
 Wx::Frame.new(nil, -1, 'title', [0,0], [500,400])
 ```
 
-In addition `Wx::Size`, `Wx::Point` and `Wx::RealPoint` support parallel assignment semantics such that you can write code like
+In addition {Wx::Size}, {Wx::Point} and {Wx::RealPoint} support parallel assignment semantics such that you can write code like
 ```ruby
   win.paint do | dc |
     # ...    
@@ -47,12 +47,12 @@ instead of
 Instances of these classes can also be converted (back) to arrays with their `#to_ary` methods.
 
 Lastly wxRuby also extends the standard Ruby Array class with conversion methods to explicitly convert
-arrays to `Wx::Size`, `Wx::Point` or `Wx::RealPoint`; respectively the `#to_size`, `#to_point` and `#to_real_point` 
+arrays to {Wx::Size}, {Wx::Point} or {Wx::RealPoint}; respectively the `#to_size`, `#to_point` and `#to_real_point` 
 methods.
 
 ## Areas (Wx::Rect)
 
-Like `Wx::Size` and `Wx::Point` wxRuby supports parallel assignment for `Wx::Rect` such that you can write code like
+Like {Wx::Size} and {Wx::Point} wxRuby supports parallel assignment for {Wx::Rect} such that you can write code like
 ```ruby
 x, y, width, height = win.get_client_rect
 ```

data/lib/wx/doc/extra/07_colour_and_font.md

@@ -21,7 +21,7 @@ For the wxRuby API similar support has been achieved for various much used argum
 
 ## Colour
 
-Wherever a `Wx::Colour` object is expected as an argument wxRuby supports the specification of `String` or `Symbol`
+Wherever a {Wx::Colour} object is expected as an argument wxRuby supports the specification of `String` or `Symbol`
 values as a developer friendly alternative. This way the following code is equivalent:
 
 ```ruby
@@ -37,7 +37,7 @@ pen.set_colour(:CYAN)
 
 ## Font
 
-Wherever a `Wx::Font` object is expected as an argument wxRuby supports the specification of a `Wx::FontInfo` object.
+Wherever a {Wx::Font} object is expected as an argument wxRuby supports the specification of a {Wx::FontInfo} object.
 This way the following code is equivalent:
 
 ```ruby

data/lib/wx/doc/extra/09_exceptions.md

@@ -50,5 +50,5 @@ end
 
 In wxRuby event handler code is executed in an exception safe way which will capture any leaking exceptions. As wxRuby 
 however has no idea why this exception was raised and how to handle it, the result will be an exit of the main event loop
-of the running `Wx::App` instance and re-raising the exception to be handled by Ruby like any unhandled application 
+of the running {Wx::App} instance and re-raising the exception to be handled by Ruby like any unhandled application 
 exception.