wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -7,15 +7,14 @@
 module Wx
 
   # This event is sent by {Wx::LayoutAlgorithm} to calculate the amount of the remaining client area that the window should occupy.
-  # === Events using this class
+  # 
+  # ### Events using this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CalculateLayoutEvent} events.
   # Event handler methods:
   # 
   # - {Wx::EvtHandler#evt_calculate_layout}(meth = nil, &block): Process a {Wx::EVT_CALCULATE_LAYOUT} event, which asks the window to take a 'bite' out of a rectangle provided by the algorithm. 
   # 
-  # === 
-  # 
   # Category:  {Wx::Events}
   # @see Wx::QueryLayoutInfoEvent
   # @see  Wx::SashLayoutWindow
@@ -30,18 +29,21 @@ module Wx
     def initialize(id=0) end
     
     # Returns the flags associated with this event.
+    # 
     # Not currently used.
     # @return [Integer]
     def get_flags; end
     alias_method :flags, :get_flags
     
     # Before the event handler is entered, returns the remaining parent client area that the window could occupy.
+    # 
     # When the event handler returns, this should contain the remaining parent client rectangle, after the event handler has subtracted the area that its window occupies.
     # @return [Wx::Rect]
     def get_rect; end
     alias_method :rect, :get_rect
     
     # Sets the flags associated with this event.
+    # 
     # Not currently used.
     # @param flags [Integer] 
     # @return [void]

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

@@ -7,19 +7,20 @@
 module Wx
 
   # The calendar control allows the user to pick a date.
+  # 
   # The user can move the current selection using the keyboard and select the date (generating EVT_CALENDAR event) by pressing <code><Return></code> or double clicking it.
   # Generic calendar has advanced possibilities for the customization of its display, described below. If you want to use these possibilities on every platform, use {Wx::GenericCalendarCtrl} instead of {Wx::CalendarCtrl}.
   # All global settings (such as colours and fonts used) can, of course, be changed. But also, the display style for each day in the month can be set independently using {Wx::CalendarDateAttr} class.
   # An item without custom attributes is drawn with the default colours and font and without border, but setting custom attributes with {Wx::CalendarCtrl#set_attr} allows modifying its appearance. Just create a custom attribute object and set it for the day you want to be displayed specially (note that the control will take ownership of the pointer, i.e. it will delete it itself). A day may be marked as being a holiday, even if it is not recognized as one by {Wx::DateTime} using the {Wx::CalendarDateAttr#set_holiday} method.
   # As the attributes are specified for each day, they may change when the month is changed, so you will often want to update them in EVT_CALENDAR_PAGE_CHANGED event handler.
-  # If neither the {Wx::CAL_SUNDAY_FIRST} or {Wx::CAL_MONDAY_FIRST} style is given, the first day of the week is determined from operating system's settings, if possible. The native wxGTK calendar chooses the first weekday based on locale, and these styles have no effect on it.
-  # === Styles
+  # If neither the {Wx::CAL_SUNDAY_FIRST} or {Wx::CAL_MONDAY_FIRST} style is given, the first day of the week is determined from operating system's settings, if possible. The native WXGTK calendar chooses the first weekday based on locale, and these styles have no effect on it.
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
-  # - {Wx::CAL_SUNDAY_FIRST}: Show Sunday as the first day in the week (not in wxGTK) 
+  # - {Wx::CAL_SUNDAY_FIRST}: Show Sunday as the first day in the week (not in WXGTK) 
   # 
-  # - {Wx::CAL_MONDAY_FIRST}: Show Monday as the first day in the week (not in wxGTK) 
+  # - {Wx::CAL_MONDAY_FIRST}: Show Monday as the first day in the week (not in WXGTK) 
   # 
   # - {Wx::CAL_SHOW_HOLIDAYS}: Highlight holidays in the calendar (only generic) 
   # 
@@ -33,7 +34,7 @@ module Wx
   # 
   # - {Wx::CAL_SHOW_WEEK_NUMBERS}: Show week numbers on the left side of the calendar. (not in generic) 
   # 
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CalendarEvent} events.
   # Event handler methods for events emitted by this class:
@@ -48,24 +49,28 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_calendar_week_clicked}(id, meth = nil, &block): User clicked on the week of the year number (only generic). 
   # 
-  # Changing the selected date will trigger an EVT_CALENDAR_DAY, MONTH or YEAR event as well as an EVT_CALENDAR_SEL_CHANGED event.
-  # 
-  # === 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>Changing the selected date will trigger an EVT_CALENDAR_DAY, MONTH or YEAR event as well as an EVT_CALENDAR_SEL_CHANGED event.
+  # </p>
+  # </div>
   # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  {Wx::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>
-  # Implementations:  native under wxGTK, wxMSW ports; a generic implementation is used elsewhere.
+  # Implementations:  native under WXGTK, WXMSW ports; a generic implementation is used elsewhere.
   # @see Calendar Sample
   # @see  Wx::CalendarDateAttr
   # @see  Wx::CalendarEvent
   # @see  Wx::DatePickerCtrl 
   # 
   # 
+  # @wxrb_require USE_CALENDARCTRL
   class CalendarCtrl < Control
   
     # Restrict the dates that can be selected in the control to the specified range.
+    # 
     # If either date is set, the corresponding limit will be enforced and true returned. If none are set, the existing restrictions are removed and false is returned.
     # 
     # true if either limit is valid, false otherwise
@@ -77,6 +82,7 @@ module Wx
     alias_method :date_range=, :set_date_range
     
     # Returns the limits currently being used.
+    # 
     # true if either limit is set, false otherwise
     # @see Wx::CalendarCtrl#set_date_range
     # @return [Array(Time, Time), nil]
@@ -99,6 +105,7 @@ module Wx
     def initialize(*args) end
     
     # Creates the control.
+    # 
     # See {Wx::Window#initialize} for the meaning of the parameters and the control overview for the possible styles.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -111,12 +118,14 @@ module Wx
     def create(parent, id, date=Wx::DEFAULT_DATE_TIME, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::CAL_SHOW_HOLIDAYS, name=Wx::CALENDAR_NAME_STR) end
     
     # This function should be used instead of changing {Wx::CAL_SHOW_HOLIDAYS} style bit directly.
+    # 
     # It enables or disables the special highlighting of the holidays.
     # @param display [Boolean] 
     # @return [void]
     def enable_holiday_display(display=true) end
     
     # This function should be used instead of changing {Wx::CAL_NO_MONTH_CHANGE} style bit.
+    # 
     # It allows or disallows the user to change the month interactively. Note that if the month cannot be changed, the year cannot be changed either.
     # true if the value of this option really changed or false if it was already set to the requested value.
     # @param enable [Boolean] 
@@ -124,6 +133,7 @@ module Wx
     def enable_month_change(enable=true) end
     
     # Returns the attribute for the given date (should be in the range 1...31).
+    # 
     # The returned pointer may be NULL. Only in generic {Wx::CalendarCtrl}.
     # @param day [Integer] 
     # @return [Wx::CalendarDateAttr]
@@ -136,6 +146,7 @@ module Wx
     alias_method :date, :get_date
     
     # Gets the background colour of the header part of the calendar window.
+    # 
     # This method is currently only implemented in generic {Wx::CalendarCtrl} and always returns {Wx::NULL_COLOUR} in the native versions.
     # @see Wx::CalendarCtrl#set_header_colours 
     # @return [Wx::Colour,String,Symbol]
@@ -143,6 +154,7 @@ module Wx
     alias_method :header_colour_bg, :get_header_colour_bg
     
     # Gets the foreground colour of the header part of the calendar window.
+    # 
     # This method is currently only implemented in generic {Wx::CalendarCtrl} and always returns {Wx::NULL_COLOUR} in the native versions.
     # @see Wx::CalendarCtrl#set_header_colours 
     # @return [Wx::Colour,String,Symbol]
@@ -150,6 +162,7 @@ module Wx
     alias_method :header_colour_fg, :get_header_colour_fg
     
     # Gets the background highlight colour.
+    # 
     # Only in generic {Wx::CalendarCtrl}.
     # This method is currently only implemented in generic {Wx::CalendarCtrl} and always returns {Wx::NULL_COLOUR} in the native versions.
     # @see Wx::CalendarCtrl#set_highlight_colours 
@@ -158,6 +171,7 @@ module Wx
     alias_method :highlight_colour_bg, :get_highlight_colour_bg
     
     # Gets the foreground highlight colour.
+    # 
     # Only in generic {Wx::CalendarCtrl}.
     # This method is currently only implemented in generic {Wx::CalendarCtrl} and always returns {Wx::NULL_COLOUR} in the native versions.
     # @see Wx::CalendarCtrl#set_highlight_colours 
@@ -166,6 +180,7 @@ module Wx
     alias_method :highlight_colour_fg, :get_highlight_colour_fg
     
     # Return the background colour currently used for holiday highlighting.
+    # 
     # Only useful with generic {Wx::CalendarCtrl} as native versions currently don't support holidays display at all and always return {Wx::NULL_COLOUR}.
     # @see Wx::CalendarCtrl#set_holiday_colours 
     # @return [Wx::Colour,String,Symbol]
@@ -173,6 +188,7 @@ module Wx
     alias_method :holiday_colour_bg, :get_holiday_colour_bg
     
     # Return the foreground colour currently used for holiday highlighting.
+    # 
     # Only useful with generic {Wx::CalendarCtrl} as native versions currently don't support holidays display at all and always return {Wx::NULL_COLOUR}.
     # @see Wx::CalendarCtrl#set_holiday_colours 
     # @return [Wx::Colour,String,Symbol]
@@ -180,7 +196,8 @@ module Wx
     alias_method :holiday_colour_fg, :get_holiday_colour_fg
     
     # Returns one of {Wx::CalendarHitTestResult} constants and fills either date or wd pointer with the corresponding value depending on the hit test code.
-    # Not implemented in wxGTK currently.
+    # 
+    # Not implemented in WXGTK currently.
     # @param pos [Array(Integer, Integer), Wx::Point] 
     # @param date [Wx::DateTime] 
     # @param wd [Wx::DateTime::WeekDay] 
@@ -188,12 +205,14 @@ module Wx
     def hit_test(pos, date=nil, wd=nil) end
     
     # Clears any attributes associated with the given day (in the range 1...31).
+    # 
     # Only in generic {Wx::CalendarCtrl}.
     # @param day [Integer] 
     # @return [void]
     def reset_attr(day) end
     
     # Associates the attribute with the specified date (in the range 1...31).
+    # 
     # If the pointer is NULL, the items attribute is cleared. Only in generic {Wx::CalendarCtrl}.
     # @param day [Integer] 
     # @param attr [Wx::CalendarDateAttr] 
@@ -201,6 +220,7 @@ module Wx
     def set_attr(day, attr) end
     
     # Sets the current date.
+    # 
     # The date parameter must be valid and in the currently valid range as set by {Wx::CalendarCtrl#set_date_range}, otherwise the current date is not changed and the function returns false and, additionally, triggers an assertion failure if the date is invalid.
     # @param date [Time,Date,DateTime] 
     # @return [Boolean]
@@ -208,6 +228,7 @@ module Wx
     alias_method :date=, :set_date
     
     # Set the colours used for painting the weekdays at the top of the control.
+    # 
     # This method is currently only implemented in generic {Wx::CalendarCtrl} and does nothing in the native versions.
     # @param colFg [Wx::Colour,String,Symbol] 
     # @param colBg [Wx::Colour,String,Symbol] 
@@ -215,6 +236,7 @@ module Wx
     def set_header_colours(colFg, colBg) end
     
     # Set the colours to be used for highlighting the currently selected date.
+    # 
     # This method is currently only implemented in generic {Wx::CalendarCtrl} and does nothing in the native versions.
     # @param colFg [Wx::Colour,String,Symbol] 
     # @param colBg [Wx::Colour,String,Symbol] 
@@ -222,6 +244,7 @@ module Wx
     def set_highlight_colours(colFg, colBg) end
     
     # Marks the specified day as being a holiday in the current month.
+    # 
     # This method is only implemented in the generic version of the control and does nothing in the native ones.
     # @param day [Integer] 
     # @return [void]
@@ -229,6 +252,7 @@ module Wx
     alias_method :holiday=, :set_holiday
     
     # Sets the colours to be used for the holidays highlighting.
+    # 
     # This method is only implemented in the generic version of the control and does nothing in the native ones. It should also only be called if the window style includes {Wx::CAL_SHOW_HOLIDAYS} flag or {Wx::CalendarCtrl#enable_holiday_display} had been called.
     # @param colFg [Wx::Colour,String,Symbol] 
     # @param colBg [Wx::Colour,String,Symbol] 
@@ -236,6 +260,7 @@ module Wx
     def set_holiday_colours(colFg, colBg) end
     
     # Mark or unmark the day.
+    # 
     # This day of month will be marked in every month. In generic {Wx::CalendarCtrl},
     # @param day [Integer] 
     # @param mark [Boolean] 

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

@@ -7,13 +7,14 @@
 module Wx
 
   # {Wx::CalendarDateAttr} is a custom attributes for a calendar date.
+  # 
   # The objects of this class are used with {Wx::CalendarCtrl}.
-  # === 
   # 
   # Category:  Data Structures
   # @see Wx::CalendarCtrl 
   # 
   # 
+  # @wxrb_require USE_CALENDARCTRL
   class CalendarDateAttr < ::Object
   
     # @overload initialize(colText=Wx::NULL_COLOUR, colBack=Wx::NULL_COLOUR, colBorder=Wx::NULL_COLOUR, font=Wx::NULL_FONT, border=Wx::CalendarDateBorder::CAL_BORDER_NONE)

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

@@ -42,6 +42,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_CALENDARCTRL
   class CalendarDateBorder < Wx::Enum
   
     # No Border (Default)
@@ -62,6 +63,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_CALENDARCTRL
   class CalendarHitTestResult < Wx::Enum
   
     # Hit outside of anything.
@@ -115,12 +117,12 @@ module Wx
   EVT_CALENDAR_WEEK_CLICKED = 10082
   
   # The {Wx::CalendarEvent} class is used together with {Wx::CalendarCtrl}.
-  # === 
   # 
   # Category:  {Wx::Events}
   # @see Wx::CalendarCtrl 
   # 
   # 
+  # @wxrb_require USE_CALENDARCTRL
   class CalendarEvent < DateEvent
   
     # @overload initialize()
@@ -128,11 +130,12 @@ module Wx
     # @overload initialize(win, dt, type)
     #   @param win [Wx::Window] 
     #   @param dt [Time,Date,DateTime] 
-    #   @param type [Wx::CommandLinkButton::EventType] 
+    #   @param type [Wx::StaticLine::EventType] 
     #   @return [Wx::CalendarEvent]
     def initialize(*args) end
     
     # Returns the week day on which the user clicked in EVT_CALENDAR_WEEKDAY_CLICKED handler.
+    # 
     # It doesn't make sense to call this function in other handlers.
     # @return [Integer]
     def get_week_day; end

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

@@ -7,10 +7,10 @@
 module Wx
 
   # A caret is a blinking cursor showing the position where the typed text will appear.
+  # 
   # Text controls usually have their own caret but {Wx::Caret} provides a way to use a caret in other windows.
   # Currently, the caret appears as a rectangle of the given size. In the future, it will be possible to specify a bitmap to be used for the caret shape.
   # A caret is always associated with a window and the current caret can be retrieved using {Wx::Window#get_caret}. The same caret can't be reused in two different windows.
-  # === 
   # 
   # Category:  {Wx::Miscellaneous}
   # 
@@ -73,6 +73,7 @@ module Wx
     alias_method :visible?, :is_visible
     
     # Shows or hides the caret.
+    # 
     # Notice that if the caret was hidden N times, it must be shown N times as well to reappear on the screen.
     # @param show [Boolean] 
     # @return [void]
@@ -83,6 +84,7 @@ module Wx
     def self.get_blink_time; end
     
     # Sets the blink time for all the carets.
+    # 
     # Under Windows, this function will change the blink time for all carets permanently (until the next time it is called), even for carets in other applications.
     # @see Wx::Caret.get_blink_time 
     # @param milliseconds [Integer] 

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

@@ -19,6 +19,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_CHECKBOX
   class CheckBoxState < Wx::Enum
   
     # 
@@ -36,8 +37,9 @@ module Wx
   end # CheckBoxState
   
   # A checkbox is a labelled box which by default is either on (checkmark is visible) or off (no checkmark).
+  # 
   # Optionally (when the {Wx::CHK_3STATE} style flag is set) it can have a third state, called the mixed or undetermined state. Often this is used as a "Does Not Apply" state.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -49,34 +51,35 @@ module Wx
   # 
   # - {Wx::Alignment::ALIGN_RIGHT}: Makes the text appear on the left of the checkbox. 
   # 
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CommandEvent} events.
   # Event handler methods for events emitted by this class:
   # 
   # - {Wx::EvtHandler#evt_checkbox}(id, meth = nil, &block): Process a {Wx::EVT_CHECKBOX} event, when the checkbox is clicked. 
   # 
-  # === 
-  # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  {Wx::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::RadioButton
   # @see  Wx::CommandEvent 
   # 
   # 
+  # @wxrb_require USE_CHECKBOX
   class CheckBox < Control
   
     # @overload initialize()
     #   Default constructor.
     #   
+    #   
     #   @see Wx::CheckBox#create
     #   @see  Wx::Validator 
     #   @return [Wx::CheckBox]
     # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::CHECK_BOX_NAME_STR)
     #   Constructor, creating and showing a checkbox.
     #   
+    #   
     #   @see Wx::CheckBox#create
     #   @see  Wx::Validator 
     #   @param parent [Wx::Window]  Parent window. Must not be NULL.
@@ -91,6 +94,7 @@ module Wx
     def initialize(*args) end
     
     # Creates the checkbox for two-step construction.
+    # 
     # See {Wx::CheckBox#initialize} for details.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -104,22 +108,26 @@ module Wx
     def create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::CHECK_BOX_NAME_STR) end
     
     # Gets the state of a 2-state checkbox.
+    # 
     # Returns true if it is checked, false otherwise.
     # @return [Boolean]
     def get_value; end
     alias_method :value, :get_value
     
     # Gets the state of a 3-state checkbox.
+    # 
     # Asserts when the function is used with a 2-state checkbox.
     # @return [Wx::CheckBoxState]
     def get3state_value; end
     
     # Returns whether or not the checkbox is a 3-state checkbox.
+    # 
     # true if this checkbox is a 3-state checkbox, false if it's a 2-state checkbox.
     # @return [Boolean]
     def is3state; end
     
     # Returns whether or not the user can set the checkbox to the third state.
+    # 
     # true if the user can set the third state of this checkbox, false if it can only be set programmatically or if it's a 2-state checkbox.
     # @return [Boolean]
     def is3rd_state_allowed_for_user; end
@@ -130,6 +138,7 @@ module Wx
     alias_method :checked?, :is_checked
     
     # Sets the checkbox to the given state.
+    # 
     # This does not cause a {Wx::EVT_CHECKBOX} event to get emitted.
     # @param state [Boolean]  If true, the check is on, otherwise it is off.
     # @return [void]
@@ -137,6 +146,7 @@ module Wx
     alias_method :value=, :set_value
     
     # Sets the checkbox to the given state.
+    # 
     # This does not cause a {Wx::EVT_CHECKBOX} event to get emitted.
     # Asserts when the checkbox is a 2-state checkbox and setting the state to {Wx::CheckBoxState::CHK_UNDETERMINED}.
     # @param state [Wx::CheckBoxState] 

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

@@ -7,19 +7,18 @@
 module Wx
 
   # A {Wx::CheckListBox} is like a {Wx::ListBox}, but allows items to be checked or unchecked.
+  # 
   # When using this class under Windows wxWidgets must be compiled with {Wx::Setup::USE_OWNER_DRAWN} set to 1.
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CommandEvent} events.
   # Event handler methods for events emitted by this class:
   # 
   # - {Wx::EvtHandler#evt_checklistbox}(id, meth = nil, &block): Process a {Wx::EVT_CHECKLISTBOX} event, when an item in the check list box is checked or unchecked. {Wx::CommandEvent#get_int} will contain the index of the item that was checked or unchecked. {Wx::CommandEvent#is_checked} is not valid! Use {Wx::CheckListBox#is_checked} instead. 
   # 
-  # === 
-  # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  {Wx::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::ListBox
   # @see  Wx::Choice
@@ -28,6 +27,7 @@ module Wx
   # @see  Wx::CommandEvent 
   # 
   # 
+  # @wxrb_require USE_CHECKLISTBOX
   class CheckListBox < ListBox
   
     # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=("LIST_BOX"))
@@ -69,6 +69,7 @@ module Wx
     def create(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::LIST_BOX_NAME_STR) end
     
     # Checks the given item.
+    # 
     # Note that calling this method does not result in a {Wx::EVT_CHECKLISTBOX} event being emitted.
     # @param item [Integer]  Index of item to check.
     # @param check [Boolean]  true if the item is to be checked, false otherwise.
@@ -82,6 +83,7 @@ module Wx
     alias_method :checked?, :is_checked
     
     # Return the indices of the checked items.
+    # 
     # The number of checked items.
     # @see Wx::CheckListBox#check
     # @see  Wx::CheckListBox#is_checked

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

@@ -7,34 +7,35 @@
 module Wx
 
   # A choice item is used to select one of a list of strings.
+  # 
   # Unlike a {Wx::ListBox}, only the selection is visible until the user pulls down the menu of choices.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
   # - {Wx::CB_SORT}: Sorts the entries alphabetically. 
   # 
-  # === Events emitted by this class
+  # ### Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CommandEvent} events.
   # Event handler methods for events emitted by this class:
   # 
   # - {Wx::EvtHandler#evt_choice}(id, meth = nil, &block): Process a {Wx::EVT_CHOICE} event, when an item on the list is selected. 
   # 
-  # === 
-  # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  {Wx::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::ListBox
   # @see  Wx::ComboBox
   # @see  Wx::CommandEvent 
   # 
   # 
+  # @wxrb_require USE_CHOICE
   class Choice < ControlWithItems
   
     # Creates the choice for two-step construction.
+    # 
     # See {Wx::Choice#initialize}.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -50,12 +51,14 @@ module Wx
     # @overload initialize()
     #   Default constructor.
     #   
+    #   
     #   @see Wx::Choice#create
     #   @see  Wx::Validator 
     #   @return [Wx::Choice]
     # @overload initialize(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::CHOICE_NAME_STR)
     #   Constructor, creating and showing a choice.
     #   
+    #   
     #   @see Wx::Choice#create
     #   @see  Wx::Validator
     #   @param parent [Wx::Window]  Parent window. Must not be NULL.
@@ -70,19 +73,30 @@ module Wx
     def initialize(*args) end
     
     # Gets the number of columns in this choice item.
-    # This is implemented for GTK and Motif only and always returns 1 for the other platforms.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This is implemented for GTK and Motif only and always returns 1 for the other platforms. 
+    # </p>
+    # </div>
     # @return [Integer]
     def get_columns; end
     alias_method :columns, :get_columns
     
     # Unlike {Wx::ControlWithItems#get_selection} which only returns the accepted selection value (the selection in the control once the user closes the dropdown list), this function returns the current selection.
+    # 
     # That is, while the dropdown list is shown, it returns the currently selected item in it. When it is not shown, its result is the same as for the other function.
     # @return [Integer]
     def get_current_selection; end
     alias_method :current_selection, :get_current_selection
     
     # Sets the number of columns in this choice item.
-    # This is implemented for GTK and Motif only and doesn’t do anything under other platforms.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This is implemented for GTK and Motif only and doesn’t do anything under other platforms. 
+    # </p>
+    # </div>
     # @param n [Integer]  Number of columns.
     # @return [void]
     def set_columns(n=1) end
@@ -90,12 +104,14 @@ module Wx
     
     # Returns the number of items in the control.
     # 
+    # 
     # @see Wx::Choice#is_empty 
     # @return [Integer]
     def get_count; end
     alias_method :count, :get_count
     
     # Returns the index of the selected item or {Wx::NOT_FOUND} if no item is selected.
+    # 
     # The position of the current selection.
     # @see Wx::Choice#set_selection
     # @see  Wx::Choice#get_string_selection 
@@ -104,6 +120,7 @@ module Wx
     alias_method :selection, :get_selection
     
     # Sets the selection to the given item n or removes the selection entirely if n == {Wx::NOT_FOUND}.
+    # 
     # Note that this does not cause any command events to be emitted nor does it deselect any other items in the controls which support multiple selections.
     # @see Wx::Choice#set_string
     # @see  Wx::Choice#set_string_selection 
@@ -113,6 +130,7 @@ module Wx
     alias_method :selection=, :set_selection
     
     # Finds an item whose label matches the given string.
+    # 
     # The zero-based position of the item, or {Wx::NOT_FOUND} if the string was not found.
     # @param string [String]  String to find.
     # @param caseSensitive [Boolean]  Whether search is case sensitive (default is not).
@@ -120,6 +138,7 @@ module Wx
     def find_string(string, caseSensitive=false) end
     
     # Returns the label of the item with the given index.
+    # 
     # The index must be valid, i.e. less than the value returned by {Wx::Choice#get_count}, otherwise an assert is triggered. Notably, this function can't be called if the control is empty.
     # 
     # The label of the item.