wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,272 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # {Wx::VListBox} is a {Wx::ListBox}-like control with the following two main differences from a regular {Wx::ListBox}: it can have an arbitrarily huge number of items because it doesn't store them itself but uses the {Wx::VListBox#on_draw_item} callback to draw them (so it is a virtual listbox) and its items can have variable height as determined by {Wx::VListBox#on_measure_item} (so it is also a listbox with the lines of variable height).
+  # 
+  # Also, as a consequence of its virtual nature, it doesn't have any methods to append or insert items in it as it isn't necessary to do it: you just have to call {Wx::VListBox#set_item_count} to tell the control how many items it should display. Of course, this also means that you will never use this class directly because it has pure virtual functions, but will need to derive your own class from it (for example, {Wx::HTML::HtmlListBox}).
+  # However it emits the same events as {Wx::ListBox} and the same event macros may be used with it. Since {Wx::VListBox} does not store its items itself, the events will only contain the index, not any contents such as the string of an item.
+  # 
+  # Category:  {Wx::Controls}
+  # @see Wx::HTML::SimpleHtmlListBox
+  # @see  Wx::HTML::HtmlListBox 
+  # 
+  # 
+  class VListBox < VScrolledCanvas
+  
+    # @overload set_margins(pt)
+    #   Set the margins: horizontal margin is the distance between the window border and the item contents while vertical margin is half of the distance between items.
+    #   
+    #   By default both margins are 0.
+    #   @param pt [Array(Integer, Integer), Wx::Point] 
+    #   @return [void]
+    # @overload set_margins(x, y)
+    #   Set the margins: horizontal margin is the distance between the window border and the item contents while vertical margin is half of the distance between items.
+    #   
+    #   By default both margins are 0.
+    #   @param x [Integer] 
+    #   @param y [Integer] 
+    #   @return [void]
+    def set_margins(*args) end
+    alias_method :margins=, :set_margins
+    
+    # @overload initialize()
+    #   Default constructor, you must call {Wx::VListBox#create} later.
+    #   @return [Wx::VListBox]
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::V_LIST_BOX_NAME_STR)
+    #   Normal constructor which calls {Wx::VListBox#create} internally.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @return [Wx::VListBox]
+    def initialize(*args) end
+    
+    # Deletes all items from the control.
+    # @return [void]
+    def clear; end
+    
+    # Creates the control.
+    # 
+    # To finish creating it you also should call {Wx::VListBox#set_item_count} to let it know about the number of items it contains.
+    # The only special style which may be used with {Wx::VListBox} is {Wx::LB_MULTIPLE} which indicates that the listbox should support multiple selection.
+    # true on success or false if the control couldn't be created.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param name [String] 
+    # @return [Boolean]
+    def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::V_LIST_BOX_NAME_STR) end
+    
+    # Deselects all the items in the listbox.
+    # 
+    # This method is only valid for multi selection listboxes.
+    # true if any items were changed, i.e. if there had been any selected items before, or false if all the items were already deselected.
+    # @see Wx::VListBox#select_all
+    # @see  Wx::VListBox#select 
+    # @return [Boolean]
+    def deselect_all; end
+    
+    # Get the number of items in the control.
+    # 
+    # 
+    # @see Wx::VListBox#set_item_count 
+    # @return [Integer]
+    def get_item_count; end
+    alias_method :item_count, :get_item_count
+    
+    # Returns the margins used by the control.
+    # 
+    # The x field of the returned point is the horizontal margin and the y field is the vertical one.
+    # @see Wx::VListBox#set_margins 
+    # @return [Wx::Point]
+    def get_margins; end
+    alias_method :margins, :get_margins
+    
+    # Returns the rectangle occupied by this item in physical coordinates.
+    # 
+    # If the item is not currently visible, returns an empty rectangle.
+    # @param item [Integer] 
+    # @return [Wx::Rect]
+    def get_item_rect(item) end
+    alias_method :item_rect, :get_item_rect
+    
+    # Returns the number of the items currently selected.
+    # 
+    # It is valid for both single and multi selection controls. In the former case it may only return 0 or 1 however.
+    # @see Wx::VListBox#is_selected
+    # @see  Wx::VListBox#get_first_selected
+    # @see  Wx::VListBox#get_next_selected 
+    # @return [Integer]
+    def get_selected_count; end
+    alias_method :selected_count, :get_selected_count
+    
+    # Get the currently selected item or {Wx::NOT_FOUND} if there is no selection.
+    # @return [Integer]
+    def get_selection; end
+    alias_method :selection, :get_selection
+    
+    # Returns the background colour used for the selected cells.
+    # 
+    # By default the standard system colour is used.
+    # @see Wx::SystemSettings.get_colour
+    # @see  Wx::VListBox#set_selection_background 
+    # @return [Wx::Colour,String,Symbol]
+    def get_selection_background; end
+    alias_method :selection_background, :get_selection_background
+    
+    # Returns true if the listbox was created with {Wx::LB_MULTIPLE} style and so supports multiple selection or false if it is a single selection listbox.
+    # @return [Boolean]
+    def has_multiple_selection; end
+    alias_method :has_multiple_selection?, :has_multiple_selection
+    
+    # Returns true if this item is the current one, false otherwise.
+    # 
+    # The current item is always the same as selected one for the single selection listbox and in this case this method is equivalent to {Wx::VListBox#is_selected} but they are different for multi selection listboxes where many items may be selected but only one (at most) is current.
+    # @param item [Integer] 
+    # @return [Boolean]
+    def is_current(item) end
+    alias_method :current?, :is_current
+    
+    # Get the current item or {Wx::NOT_FOUND} if there is no current item.
+    # @return [Integer]
+    def get_current; end
+    alias_method :current, :get_current
+    
+    # Set the specified item as the current item, if it is {Wx::NOT_FOUND} the current item is unset.
+    # 
+    # The current item will be automatically scrolled into view if it isn't currently visible.
+    # @param current [Integer] 
+    # @return [void]
+    def set_current(current) end
+    alias_method :current=, :set_current
+    
+    # Returns true if this item is selected, false otherwise.
+    # @param item [Integer] 
+    # @return [Boolean]
+    def is_selected(item) end
+    alias_method :selected?, :is_selected
+    
+    # Selects or deselects the specified item which must be valid (i.e. not equal to {Wx::NOT_FOUND}).
+    # 
+    # true if the items selection status has changed or false otherwise.
+    # 
+    # This function is only valid for the multiple selection listboxes, use {Wx::VListBox#set_selection} for the single selection ones.
+    # @param item [Integer] 
+    # @param select [Boolean] 
+    # @return [Boolean]
+    def select(item, select=true) end
+    
+    # Selects all the items in the listbox.
+    # 
+    # true if any items were changed, i.e. if there had been any unselected items before, or false if all the items were already selected.
+    # 
+    # This method is only valid for multi selection listboxes.
+    # @see Wx::VListBox#deselect_all
+    # @see  Wx::VListBox#select 
+    # @return [Boolean]
+    def select_all; end
+    
+    # Selects all items in the specified range which may be given in any order.
+    # 
+    # true if the items selection status has changed or false otherwise.
+    # 
+    # This method is only valid for multi selection listboxes.
+    # @see Wx::VListBox#select_all
+    # @see  Wx::VListBox#select 
+    # @param from [Integer] 
+    # @param to [Integer] 
+    # @return [Boolean]
+    def select_range(from, to) end
+    
+    # Set the number of items to be shown in the control.
+    # 
+    # This is just a synonym for {Wx::VScrolledWindow#set_row_count}.
+    # @param count [Integer] 
+    # @return [void]
+    def set_item_count(count) end
+    alias_method :item_count=, :set_item_count
+    
+    # Set the selection to the specified item, if it is -1 the selection is unset.
+    # 
+    # The selected item will be automatically scrolled into view if it isn't currently visible.
+    # This method may be used both with single and multiple selection listboxes.
+    # @param selection [Integer] 
+    # @return [void]
+    def set_selection(selection) end
+    alias_method :selection=, :set_selection
+    
+    # Sets the colour to be used for the selected cells background.
+    # 
+    # The background of the standard cells may be changed by simply calling {Wx::Window#set_background_colour}.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Using a non-default background colour may result in control having an appearance different from the similar native controls and should be avoided in general.
+    # </p>
+    # </div>
+    # @see Wx::VListBox#get_selection_background 
+    # @param col [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_selection_background(col) end
+    alias_method :selection_background=, :set_selection_background
+    
+    # Toggles the state of the specified item, i.e. selects it if it was unselected and deselects it if it was selected.
+    # 
+    # This method is only valid for multi selection listboxes.
+    # @see Wx::VListBox#select 
+    # @param item [Integer] 
+    # @return [void]
+    def toggle(item) end
+    
+    
+    protected
+    
+    # The derived class must implement this function to actually draw the item with the given index on the provided DC.
+    # 
+    # TodoChange this function signature to non-const.
+    # @param dc [Wx::DC]  The device context to use for drawing.
+    # @param rect [Wx::Rect]  The bounding rectangle for the item being drawn (DC clipping region is set to this rectangle before calling this function).
+    # @param n [Integer]  The index of the item to be drawn.
+    # @return [void]
+    def on_draw_item(dc, rect, n) end
+    
+    # This method is used to draw the item's background and, maybe, a border around it.
+    # 
+    # The base class version implements a reasonable default behaviour which consists in drawing the selected item with the standard background colour and drawing a border around the item if it is either selected or current.
+    # TodoChange this function signature to non-const.
+    # @param dc [Wx::DC] 
+    # @param rect [Wx::Rect] 
+    # @param n [Integer] 
+    # @return [void]
+    def on_draw_background(dc, rect, n) end
+    
+    # This method may be used to draw separators between the lines.
+    # 
+    # The rectangle passed to it may be modified, typically to deflate it a bit before passing to {Wx::VListBox#on_draw_item}.
+    # The base class version of this method doesn't do anything.
+    # 
+    # TodoChange this function signature to non-const.
+    # @param dc [Wx::DC]  The device context to use for drawing.
+    # @param rect [Wx::Rect]  The bounding rectangle for the item.
+    # @param n [Integer]  The index of the item.
+    # @return [void]
+    def on_draw_separator(dc, rect, n) end
+    
+    # The derived class must implement this method to return the height of the specified item (in pixels).
+    # @param n [Integer] 
+    # @return [Integer]
+    def on_measure_item(n) end
+    
+  end # VListBox
+  
+
+end

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

@@ -0,0 +1,195 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # In the name of this class, "V" may stand for "variable" because it can be used for scrolling rows of variable heights; "virtual", because it is not necessary to know the heights of all rows in advance  only those which are shown on the screen need to be measured; or even "vertical", because this class only supports scrolling vertically.
+  # 
+  # In any case, this is a generalization of {Wx::Scrolled} which can be only used when all rows have the same heights. It lacks some other {Wx::Scrolled} features however, notably it can't scroll specific pixel sizes of the window or its exact client area size.
+  # To use this class, you need to derive from it and implement the Wx::VScrolled#on_get_row_height pure virtual method. You also must call Wx::VScrolled#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::VScrolled}. You only need to draw the visible part of contents in your <code>OnPaint()</code> method as usual. You should use Wx::VScrolled#get_visible_rows_begin and Wx::VScrolled#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.
+  # Note that this template class is available since wxWidgets 3.3.1, only {Wx::VScrolledWindow} was available in the earlier versions.
+  # 
+  # Category:  Miscellaneous Windows
+  # @see Wx::VScrolledWindow
+  # @see  Wx::VScrolledCanvas 
+  # 
+  # @see Wx::HScrolledWindow
+  # @see  Wx::HVScrolledWindow 
+  # 
+  # 
+  class VScrolledCanvas < Window
+  
+    # @overload initialize()
+    #   Default constructor, you must call Wx::VScrolled#create later.
+    #   @return [Wx::VScrolledCanvas]
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PANEL_NAME_STR)
+    #   This is the normal constructor, no need to call Wx::VScrolled#create after using this constructor.
+    #   
+    #   <div class="wxrb-note">
+    #   <b>Note:</b>
+    #   <p>{Wx::VSCROLL} is always automatically added to the style, there is no need to specify it explicitly.
+    #   </p>
+    #   </div>
+    #   @param parent [Wx::Window]  The parent window, must not be nil.
+    #   @param id [Integer]  The identifier of this window, {Wx::StandardID::ID_ANY} by default.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  The initial window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  The initial window size.
+    #   @param style [Integer]  The window style. There are no special style bits defined for this class.
+    #   @param name [String]  The name for this window; usually not used.
+    #   @return [Wx::VScrolledCanvas]
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PANEL_NAME_STR, &block)
+    #   This is the normal constructor, no need to call Wx::VScrolled#create after using this constructor.
+    #   
+    #   <div class="wxrb-note">
+    #   <b>Note:</b>
+    #   <p>{Wx::VSCROLL} is always automatically added to the style, there is no need to specify it explicitly.
+    #   </p>
+    #   </div>
+    #   @param parent [Wx::Window]  The parent window, must not be nil.
+    #   @param id [Integer]  The identifier of this window, {Wx::StandardID::ID_ANY} by default.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  The initial window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  The initial window size.
+    #   @param style [Integer]  The window style. There are no special style bits defined for this class.
+    #   @param name [String]  The name for this window; usually not used.
+    #   @yieldparam [Wx::VScrolledCanvas] win new instance
+    #   @return [Wx::VScrolledCanvas]
+    def initialize(*args) end
+    
+    # Same as the non-default constructor, but returns a status code: true if ok, false if the window couldn't be created.
+    # 
+    # Just as with the constructor, the {Wx::VSCROLL} style is always used, there is no need to specify it explicitly.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param name [String] 
+    # @return [Boolean]
+    def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PANEL_NAME_STR) end
+    
+    # Returns the number of rows the target window contains.
+    # 
+    # 
+    # @see Wx::VScrolled#set_row_count 
+    # @return [Integer]
+    def get_row_count; end
+    alias_method :row_count, :get_row_count
+    
+    # Returns the index of the first visible row based on the scroll position.
+    # @return [Integer]
+    def get_visible_rows_begin; end
+    alias_method :visible_rows_begin, :get_visible_rows_begin
+    
+    # Returns the index of the last visible row based on the scroll position.
+    # 
+    # This includes the last row even if it is only partially visible.
+    # @return [Integer]
+    def get_visible_rows_end; end
+    alias_method :visible_rows_end, :get_visible_rows_end
+    
+    # Returns true if the given row is currently visible (even if only partially visible) or false otherwise.
+    # @param row [Integer] 
+    # @return [Boolean]
+    def is_row_visible(row) end
+    alias_method :row_visible?, :is_row_visible
+    
+    # Triggers a refresh for just the given row's area of the window if it's visible.
+    # @param row [Integer] 
+    # @return [void]
+    def refresh_row(row) end
+    
+    # Triggers a refresh for the area between the specified range of rows given (inclusively).
+    # @param from [Integer] 
+    # @param to [Integer] 
+    # @return [void]
+    def refresh_rows(from, to) end
+    
+    # Scroll by the specified number of pages which may be positive (to scroll down) or negative (to scroll up).
+    # @param pages [Integer] 
+    # @return [Boolean]
+    def scroll_row_pages(pages) end
+    
+    # Scroll by the specified number of rows which may be positive (to scroll down) or negative (to scroll up).
+    # 
+    # true if the window was scrolled, false otherwise (for example, if we're trying to scroll down but we are already showing the last row).
+    # @param rows [Integer] 
+    # @return [Boolean]
+    def scroll_rows(rows) end
+    
+    # Scroll to the specified row.
+    # 
+    # It will become the first visible row in the window.
+    # true if we scrolled the window, false if nothing was done.
+    # @param row [Integer] 
+    # @return [Boolean]
+    def scroll_to_row(row) end
+    
+    # Set the number of rows the window contains.
+    # 
+    # The derived class must provide the heights for all rows with indices up to the one given here in it's Wx::VScrolled#on_get_row_height implementation.
+    # @see Wx::VScrolled#get_row_count 
+    # @param rowCount [Integer] 
+    # @return [void]
+    def set_row_count(rowCount) end
+    alias_method :row_count=, :set_row_count
+    
+    # With physical scrolling on (when this is true), the device origin is changed properly when a {Wx::PaintDC} is prepared, children are actually moved and laid out properly, and the contents of the window (pixels) are actually moved.
+    # 
+    # When this is false, you are responsible for repainting any invalidated areas of the window yourself to account for the new scroll position.
+    # @param scrolling [Boolean] 
+    # @return [void]
+    def enable_physical_scrolling(scrolling=true) end
+    
+    # Returns the index of the first visible unit based on the scroll position.
+    # @return [Integer]
+    def get_visible_begin; end
+    alias_method :visible_begin, :get_visible_begin
+    
+    # Returns the index of the last visible unit based on the scroll position.
+    # 
+    # This includes the last unit even if it is only partially visible.
+    # @return [Integer]
+    def get_visible_end; end
+    alias_method :visible_end, :get_visible_end
+    
+    # Returns true if the given scroll unit is currently visible (even if only partially visible) or false otherwise.
+    # @param unit [Integer] 
+    # @return [Boolean]
+    def is_visible(unit) end
+    alias_method :visible?, :is_visible
+    
+    # Recalculate all parameters and repaint all units.
+    # @return [void]
+    def refresh_all; end
+    
+    # Returns the virtual scroll unit under the device unit given accounting for scroll position or {Wx::NOT_FOUND} if none (i.e.
+    # 
+    # if it is below the last item).
+    # @param coord [Integer] 
+    # @return [Integer]
+    def virtual_hit_test(coord) end
+    
+    
+    protected
+    
+    # This function doesn't have to be overridden but it may be useful to do so if calculating the rows' sizes is a relatively expensive operation as it gives your code a chance to calculate several of them at once and cache the result if necessary.
+    # 
+    # Wx::VScrolled#on_get_rows_height_hint is normally called just before Wx::VScrolled#on_get_row_height but you shouldn't rely on the latter being called for all rows in the interval specified here. It is also possible that Wx::VScrolled#on_get_row_height will be called for units outside of this interval, so this is really just a hint, not a promise.
+    # Finally, note that rowMin is inclusive, while rowMax is exclusive.
+    # @param rowMin [Integer] 
+    # @param rowMax [Integer] 
+    # @return [void]
+    def on_get_rows_height_hint(rowMin, rowMax) end
+    
+    # This function must be overridden in the derived class, and should return the height of the given row in pixels.
+    # @param row [Integer] 
+    # @return [Integer]
+    def on_get_row_height(row) end
+    
+  end # VScrolledCanvas
+  
+
+end

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

@@ -0,0 +1,191 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # In the name of this class, "V" may stand for "variable" because it can be used for scrolling rows of variable heights; "virtual", because it is not necessary to know the heights of all rows in advance  only those which are shown on the screen need to be measured; or even "vertical", because this class only supports scrolling vertically.
+  # 
+  # In any case, this is a generalization of {Wx::Scrolled} which can be only used when all rows have the same heights. It lacks some other {Wx::Scrolled} features however, notably it can't scroll specific pixel sizes of the window or its exact client area size.
+  # To use this class, you need to derive from it and implement the Wx::VScrolled#on_get_row_height pure virtual method. You also must call Wx::VScrolled#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::VScrolled}. You only need to draw the visible part of contents in your <code>OnPaint()</code> method as usual. You should use Wx::VScrolled#get_visible_rows_begin and Wx::VScrolled#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.
+  # Note that this template class is available since wxWidgets 3.3.1, only {Wx::VScrolledWindow} was available in the earlier versions.
+  # 
+  # Category:  Miscellaneous Windows
+  # @see Wx::VScrolledWindow
+  # @see  Wx::VScrolledCanvas 
+  # 
+  # @see Wx::HScrolledWindow
+  # @see  Wx::HVScrolledWindow 
+  # 
+  # 
+  class VScrolledWindow < Panel
+  
+    # @overload initialize()
+    #   Default constructor, you must call Wx::VScrolled#create later.
+    #   @return [Wx::VScrolledWindow]
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PANEL_NAME_STR)
+    #   This is the normal constructor, no need to call Wx::VScrolled#create after using this constructor.
+    #   
+    #   <div class="wxrb-note">
+    #   <b>Note:</b>
+    #   <p>{Wx::VSCROLL} is always automatically added to the style, there is no need to specify it explicitly.
+    #   </p>
+    #   </div>
+    #   @param parent [Wx::Window]  The parent window, must not be nil.
+    #   @param id [Integer]  The identifier of this window, {Wx::StandardID::ID_ANY} by default.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  The initial window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  The initial window size.
+    #   @param style [Integer]  The window style. There are no special style bits defined for this class.
+    #   @param name [String]  The name for this window; usually not used.
+    #   @return [Wx::VScrolledWindow]
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PANEL_NAME_STR, &block)
+    #   This is the normal constructor, no need to call Wx::VScrolled#create after using this constructor.
+    #   
+    #   <div class="wxrb-note">
+    #   <b>Note:</b>
+    #   <p>{Wx::VSCROLL} is always automatically added to the style, there is no need to specify it explicitly.
+    #   </p>
+    #   </div>
+    #   @param parent [Wx::Window]  The parent window, must not be nil.
+    #   @param id [Integer]  The identifier of this window, {Wx::StandardID::ID_ANY} by default.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  The initial window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  The initial window size.
+    #   @param style [Integer]  The window style. There are no special style bits defined for this class.
+    #   @param name [String]  The name for this window; usually not used.
+    #   @yieldparam [Wx::VScrolledWindow] win new instance
+    #   @return [Wx::VScrolledWindow]
+    def initialize(*args) end
+    
+    # Same as the non-default constructor, but returns a status code: true if ok, false if the window couldn't be created.
+    # 
+    # Just as with the constructor, the {Wx::VSCROLL} style is always used, there is no need to specify it explicitly.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param name [String] 
+    # @return [Boolean]
+    def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::PANEL_NAME_STR) end
+    
+    # Returns the number of rows the target window contains.
+    # 
+    # 
+    # @see Wx::VScrolled#set_row_count 
+    # @return [Integer]
+    def get_row_count; end
+    alias_method :row_count, :get_row_count
+    
+    # Returns the index of the first visible row based on the scroll position.
+    # @return [Integer]
+    def get_visible_rows_begin; end
+    alias_method :visible_rows_begin, :get_visible_rows_begin
+    
+    # Returns the index of the last visible row based on the scroll position.
+    # 
+    # This includes the last row even if it is only partially visible.
+    # @return [Integer]
+    def get_visible_rows_end; end
+    alias_method :visible_rows_end, :get_visible_rows_end
+    
+    # Returns true if the given row is currently visible (even if only partially visible) or false otherwise.
+    # @param row [Integer] 
+    # @return [Boolean]
+    def is_row_visible(row) end
+    alias_method :row_visible?, :is_row_visible
+    
+    # Triggers a refresh for just the given row's area of the window if it's visible.
+    # @param row [Integer] 
+    # @return [void]
+    def refresh_row(row) end
+    
+    # Triggers a refresh for the area between the specified range of rows given (inclusively).
+    # @param from [Integer] 
+    # @param to [Integer] 
+    # @return [void]
+    def refresh_rows(from, to) end
+    
+    # Scroll by the specified number of pages which may be positive (to scroll down) or negative (to scroll up).
+    # @param pages [Integer] 
+    # @return [Boolean]
+    def scroll_row_pages(pages) end
+    
+    # Scroll by the specified number of rows which may be positive (to scroll down) or negative (to scroll up).
+    # 
+    # true if the window was scrolled, false otherwise (for example, if we're trying to scroll down but we are already showing the last row).
+    # @param rows [Integer] 
+    # @return [Boolean]
+    def scroll_rows(rows) end
+    
+    # Scroll to the specified row.
+    # 
+    # It will become the first visible row in the window.
+    # true if we scrolled the window, false if nothing was done.
+    # @param row [Integer] 
+    # @return [Boolean]
+    def scroll_to_row(row) end
+    
+    # Set the number of rows the window contains.
+    # 
+    # The derived class must provide the heights for all rows with indices up to the one given here in it's Wx::VScrolled#on_get_row_height implementation.
+    # @see Wx::VScrolled#get_row_count 
+    # @param rowCount [Integer] 
+    # @return [void]
+    def set_row_count(rowCount) end
+    alias_method :row_count=, :set_row_count
+    
+    # With physical scrolling on (when this is true), the device origin is changed properly when a {Wx::PaintDC} is prepared, children are actually moved and laid out properly, and the contents of the window (pixels) are actually moved.
+    # 
+    # When this is false, you are responsible for repainting any invalidated areas of the window yourself to account for the new scroll position.
+    # @param scrolling [Boolean] 
+    # @return [void]
+    def enable_physical_scrolling(scrolling=true) end
+    
+    # Returns the index of the first visible unit based on the scroll position.
+    # @return [Integer]
+    def get_visible_begin; end
+    alias_method :visible_begin, :get_visible_begin
+    
+    # Returns the index of the last visible unit based on the scroll position.
+    # 
+    # This includes the last unit even if it is only partially visible.
+    # @return [Integer]
+    def get_visible_end; end
+    alias_method :visible_end, :get_visible_end
+    
+    # Returns true if the given scroll unit is currently visible (even if only partially visible) or false otherwise.
+    # @param unit [Integer] 
+    # @return [Boolean]
+    def is_visible(unit) end
+    alias_method :visible?, :is_visible
+    
+    # Returns the virtual scroll unit under the device unit given accounting for scroll position or {Wx::NOT_FOUND} if none (i.e.
+    # 
+    # if it is below the last item).
+    # @param coord [Integer] 
+    # @return [Integer]
+    def virtual_hit_test(coord) end
+    
+    
+    protected
+    
+    # This function doesn't have to be overridden but it may be useful to do so if calculating the rows' sizes is a relatively expensive operation as it gives your code a chance to calculate several of them at once and cache the result if necessary.
+    # 
+    # Wx::VScrolled#on_get_rows_height_hint is normally called just before Wx::VScrolled#on_get_row_height but you shouldn't rely on the latter being called for all rows in the interval specified here. It is also possible that Wx::VScrolled#on_get_row_height will be called for units outside of this interval, so this is really just a hint, not a promise.
+    # Finally, note that rowMin is inclusive, while rowMax is exclusive.
+    # @param rowMin [Integer] 
+    # @param rowMax [Integer] 
+    # @return [void]
+    def on_get_rows_height_hint(rowMin, rowMax) end
+    
+    # This function must be overridden in the derived class, and should return the height of the given row in pixels.
+    # @param row [Integer] 
+    # @return [Integer]
+    def on_get_row_height(row) end
+    
+  end # VScrolledWindow
+  
+
+end