wxruby3 0.9.0.pre.beta.2-x64-mingw-ucrt-3.2-3.2.2

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

@@ -0,0 +1,145 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  CHK_2STATE = 16384
+  
+  # 
+  CHK_3STATE = 4096
+  
+  # 
+  CHK_ALLOW_3RD_STATE_FOR_USER = 8192
+  
+  # The possible states of a 3-state {Wx::CheckBox} (Compatible with the 2-state {Wx::CheckBox}).
+  # 
+  # 
+  # 
+  class CheckBoxState < Wx::Enum
+  
+    # 
+    # 
+    CHK_UNCHECKED = Wx::CheckBoxState.new(0)
+    
+    # 
+    # 
+    CHK_CHECKED = Wx::CheckBoxState.new(1)
+    
+    # 3-state checkbox only
+    # 
+    CHK_UNDETERMINED = Wx::CheckBoxState.new(2)
+    
+  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
+  # 
+  # This class supports the following styles:
+  #  
+  # - {Wx::CHK_2STATE}: Create a 2-state checkbox. This is the default. 
+  # - {Wx::CHK_3STATE}: Create a 3-state checkbox. 
+  # - {Wx::CHK_ALLOW_3RD_STATE_FOR_USER}: By default a user can't set a 3-state checkbox to the third state. It can only be done from code. Using this flags allows the user to set the checkbox to the third state by clicking. 
+  # - {Wx::Alignment::ALIGN_RIGHT}: Makes the text appear on the left of the checkbox. 
+  # 
+  # === 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> {Wx::MSW} Appearance
+  #   </td><td> {Wx::GTK} Appearance
+  #   </td><td> {Wx::OSX} Appearance
+  #   </td></tr></table></div>
+  # @see Wx::RadioButton
+  # @see  Wx::CommandEvent 
+  # 
+  # 
+  class CheckBox < Control
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   
+    #   @see Wx::CheckBox#create
+    #   @see  Wx::Validator 
+    #   @return [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.
+    #   @param id [Integer]  Checkbox identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param label [String]  Text to be displayed next to the checkbox.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Checkbox position. If {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Checkbox size. If {Wx::DEFAULT_SIZE} is specified then a default size is chosen.
+    #   @param style [Integer]  Window style. See {Wx::CheckBox}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @return [CheckBox]
+    def initialize(*args) end
+    
+    # Creates the checkbox for two-step construction.
+    # See {Wx::CheckBox#check_box} for details.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param label [String] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param validator [Wx::Validator] 
+    # @param name [String] 
+    # @return [true,false]
+    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 [true,false]
+    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 [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 [true,false]
+    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 [true,false]
+    def is3rd_state_allowed_for_user; end
+    
+    # This is just a maybe more readable synonym for {Wx::CheckBox#get_value}: just as the latter, it returns true if the checkbox is checked and false otherwise.
+    # @return [true,false]
+    def is_checked; end
+    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 [true,false]  If true, the check is on, otherwise it is off.
+    # @return [void]
+    def set_value(state) end
+    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 [CheckBoxState] 
+    # @return [void]
+    def set3state_value(state) end
+    
+  end # CheckBox
+  
+
+end

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

@@ -0,0 +1,96 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+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
+  # 
+  # 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> {Wx::MSW} Appearance
+  #   </td><td> {Wx::GTK} Appearance
+  #   </td><td> {Wx::OSX} Appearance
+  #   </td></tr></table></div>
+  # @see Wx::ListBox
+  # @see  Wx::Choice
+  # @see  Wx::ComboBox
+  # @see  Wx::ListCtrl
+  # @see  Wx::CommandEvent 
+  # 
+  # 
+  class CheckListBox < ListBox
+  
+    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=("Wx::LIST_BOX"))
+    #   Constructor, creating and showing a list box.
+    #   <b>{Wx::Perl} Note:</b> Not supported by {Wx::Perl}.
+    #   @param parent [Wx::Window]  Parent window. Must not be NULL.
+    #   @param id [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Window position. If {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
+    #   @param choices [Array<String>]  An array of strings with which to initialise the control.
+    #   @param style [Integer]  Window style. See {Wx::CheckListBox}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @return [CheckListBox]
+    # @overload initialize(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=("Wx::LIST_BOX"))
+    #   Constructor, creating and showing a list box.
+    #   <b>{Wx::Perl} Note:</b> Use an array reference for the choices parameter.
+    #   @param parent [Wx::Window]  Parent window. Must not be NULL.
+    #   @param id [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
+    #   @param choices [Array<String>]  An array of strings with which to initialise the control.
+    #   @param style [Integer]  Window style. See {Wx::CheckListBox}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @return [CheckListBox]
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [CheckListBox]
+    def initialize(*args) end
+    
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param choices [Array<String>] 
+    # @param style [Integer] 
+    # @param validator [Wx::Validator] 
+    # @param name [String] 
+    # @return [true,false]
+    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 [true,false]  true if the item is to be checked, false otherwise.
+    # @return [void]
+    def check(item, check=true) end
+    
+    # Returns true if the given item is checked, false otherwise.
+    # @param item [Integer]  Index of item whose check status is to be returned.
+    # @return [true,false]
+    def is_checked(item) end
+    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
+    # @return [Array<Integer>]
+    def get_checked_items; end
+    alias_method :checked_items, :get_checked_items
+    
+  end # CheckListBox
+  
+
+end

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

@@ -0,0 +1,143 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+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
+  # 
+  # This class supports the following styles:
+  #  
+  # - {Wx::CB_SORT}: Sorts the entries alphabetically. 
+  # 
+  # === 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> {Wx::MSW} Appearance
+  #   </td><td> {Wx::GTK} Appearance
+  #   </td><td> {Wx::OSX} Appearance
+  #   </td></tr></table></div>
+  # @see Wx::ListBox
+  # @see  Wx::ComboBox
+  # @see  Wx::CommandEvent 
+  # 
+  # 
+  class Choice < ControlWithItems
+  
+    # Creates the choice for two-step construction.
+    # See {Wx::Choice#choice}.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param choices [Array<String>] 
+    # @param style [Integer] 
+    # @param validator [Wx::Validator] 
+    # @param name [String] 
+    # @return [true,false]
+    def create(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::CHOICE_NAME_STR) end
+    
+    # @overload initialize()
+    #   Default constructor.
+    #   
+    #   @see Wx::Choice#create
+    #   @see  Wx::Validator 
+    #   @return [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.
+    #   <b>{Wx::Perl} Note:</b> Use an array reference for the choices parameter.
+    #   @see Wx::Choice#create
+    #   @see  Wx::Validator
+    #   @param parent [Wx::Window]  Parent window. Must not be NULL.
+    #   @param id [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then the choice is sized appropriately.
+    #   @param choices [Array<String>]  An array of strings with which to initialise the choice control.
+    #   @param style [Integer]  Window style. See {Wx::Choice}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @return [Choice]
+    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.
+    # @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.
+    # @param n [Integer]  Number of columns.
+    # @return [void]
+    def set_columns(n=1) end
+    alias_method :columns=, :set_columns
+    
+    # @return [true,false]
+    def is_sorted; end
+    alias_method :sorted?, :is_sorted
+    
+    # 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 
+    # @return [Integer]
+    def get_selection; end
+    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 
+    # @param n [Integer]  The string position to select, starting from zero.
+    # @return [void]
+    def set_selection(n) end
+    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 [true,false]  Whether search is case sensitive (default is not).
+    # @return [Integer]
+    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.
+    # @param n [Integer]  The zero-based index.
+    # @return [String]
+    def get_string(n) end
+    alias_method :string, :get_string
+    
+    # Sets the label for the given item.
+    # @param n [Integer]  The zero-based item index.
+    # @param string [String]  The label to set.
+    # @return [void]
+    def set_string(n, string) end
+    
+  end # Choice
+  
+
+end

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

@@ -0,0 +1,100 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  CHB_DEFAULT = 0
+  
+  # 
+  CHB_TOP = 16
+  
+  # 
+  CHB_BOTTOM = 32
+  
+  # 
+  CHB_LEFT = 64
+  
+  # 
+  CHB_RIGHT = 128
+  
+  # 
+  CHB_ALIGN_MASK = 240
+  
+  # 
+  # 
+  EVT_CHOICEBOOK_PAGE_CHANGED = 10103
+  
+  # 
+  # 
+  EVT_CHOICEBOOK_PAGE_CHANGING = 10102
+  
+  # {Wx::Choicebook} is a class similar to {Wx::Notebook}, but uses a {Wx::Choice} control to show the labels instead of the tabs.
+  # For usage documentation of this class, please refer to the base abstract class {Wx::BookCtrl}. You can also use the Notebook Sample to see {Wx::Choicebook} in action.
+  # {Wx::Choicebook} allows the use of {Wx::BookCtrlBase#get_control_sizer}, allowing a program to add other controls next to the choice control. This is particularly useful when screen space is restricted, as it often is when {Wx::Choicebook} is being employed.
+  # === Styles
+  # 
+  # This class supports the following styles:
+  #  
+  # - {Wx::CHB_DEFAULT}: Choose the default location for the labels depending on the current platform (but currently it's the same everywhere, namely {Wx::CHB_TOP}). 
+  # - {Wx::CHB_TOP}: Place labels above the page area. 
+  # - {Wx::CHB_LEFT}: Place labels on the left side. 
+  # - {Wx::CHB_RIGHT}: Place labels on the right side. 
+  # - {Wx::CHB_BOTTOM}: Place labels below the page area. 
+  # 
+  # === Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::BookCtrlEvent} events.
+  # Event handler methods for events emitted by this class:
+  # - {Wx::EvtHandler#evt_choicebook_page_changed}(id, meth = nil, &block): The page selection was changed. Processes a {Wx::EVT_CHOICEBOOK_PAGE_CHANGED} event. 
+  # - {Wx::EvtHandler#evt_choicebook_page_changing}(id, meth = nil, &block): The page selection is about to be changed. Processes a {Wx::EVT_CHOICEBOOK_PAGE_CHANGING} event. This event can be vetoed (using {Wx::NotifyEvent#veto}). 
+  # 
+  # === 
+  # 
+  # Category:  Book Controls  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
+  #   </td><td> {Wx::GTK} Appearance
+  #   </td><td> {Wx::OSX} Appearance
+  #   </td></tr></table></div>
+  # @see wxBookCtrl Overview
+  # @see  Wx::Notebook
+  # @see  Notebook Sample 
+  # 
+  # 
+  class Choicebook < BookCtrlBase
+  
+    # @overload initialize()
+    #   Constructs a choicebook control.
+    #   @return [Choicebook]
+    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::EMPTY_STRING)
+    #   Constructs a choicebook control.
+    #   @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 [Choicebook]
+    def initialize(*args) end
+    
+    # Create the choicebook control that has already been constructed with the default constructor.
+    # @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 [true,false]
+    def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::EMPTY_STRING) end
+    
+    # Returns the {Wx::Choice} associated with the control.
+    # @return [Wx::Choice]
+    def get_choice_ctrl; end
+    alias_method :choice_ctrl, :get_choice_ctrl
+    
+  end # Choicebook
+  
+
+end

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

@@ -0,0 +1,49 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # {Wx::ClientDC} is primarily useful for obtaining information about the window from outside EVT_PAINT() handler.
+  # Typical use of this class is to obtain the extent of some text string in order to allocate enough size for a window, e.g. 
+  # 
+  #       // Create the initially empty label with the size big enough to show
+  #       // the given string.
+  #       wxClientDC dc(this);
+  #       wxStaticText* text = new wxStaticText
+  #           (
+  #               this, wxID_ANY, "",
+  #               wxPoint(),
+  #               dc.GetTextExtent("String of max length"),
+  #               wxST_NO_AUTORESIZE
+  #           );
+  #   }
+  # 
+  # While {Wx::ClientDC} may also be used for drawing on the client area of a window from outside an EVT_PAINT() handler in some ports, this does not work on all platforms (neither {Wx::OSX} nor {Wx::GTK} with GTK 3 Wayland backend support this, so drawing using {Wx::ClientDC} simply doesn't have any effect there) and the only portable way of drawing is via {Wx::PaintDC}. To redraw a small part of the window, use {Wx::Window#refresh_rect} to invalidate just this part and check {Wx::Window#get_update_region} in the paint event handler to redraw this part only.
+  # 
+  # {Wx::ClientDC} objects should normally be constructed as temporary stack objects, i.e. don't store a {Wx::ClientDC} object.
+  # A {Wx::ClientDC} object is initialized to use the same font and colours as the window it is associated with.
+  # === 
+  # 
+  # Category:  Device Contexts
+  # @see Wx::DC
+  # @see  Wx::MemoryDC
+  # @see  Wx::PaintDC
+  # @see  Wx::WindowDC
+  # @see  Wx::ScreenDC 
+  # 
+  # 
+  class ClientDC < WindowDC
+  
+    # Constructor.
+    # Pass a pointer to the window on which you wish to paint.
+    # @param window [Wx::Window] 
+    # @return [ClientDC]
+    def initialize(window) end
+    
+  end # ClientDC
+  
+
+end

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

@@ -0,0 +1,128 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A class for manipulating the clipboard.
+  # To use the clipboard, you call member functions of the global {Wx::TheClipboard} object.
+  # See the wxDataObject Overview for further information.
+  # Call {Wx::Clipboard#open} to get ownership of the clipboard. If this operation returns true, you now own the clipboard. Call {Wx::Clipboard#set_data} to put data on the clipboard, or {Wx::Clipboard#get_data} to retrieve data from the clipboard. Call {Wx::Clipboard#close} to close the clipboard and relinquish ownership. You should keep the clipboard open only momentarily.
+  # For example:
+  # 
+  #   // Write some text to the clipboard
+  #   if (wxTheClipboard->Open())
+  #   {
+  #       // This data objects are held by the clipboard,
+  #       // so do not delete them in the app.
+  #       wxTheClipboard->SetData( new wxTextDataObject("Some text") );
+  #       wxTheClipboard->Close();
+  #   }
+  #   
+  #   // Read some text
+  #   if (wxTheClipboard->Open())
+  #   {
+  #       if (wxTheClipboard->IsSupported( wxDF_TEXT ))
+  #       {
+  #           wxTextDataObject data;
+  #           wxTheClipboard->GetData( data );
+  #           wxMessageBox( data.GetText() );
+  #       }
+  #       wxTheClipboard->Close();
+  #   }
+  # 
+  # On GTK, the clipboard behavior can vary depending on the configuration of the end-user's machine. In order for the clipboard data to persist after the window closes, a clipboard manager must be installed. Some clipboard managers will automatically flush the clipboard after each new piece of data is added, while others will not. The {Wx::Clipboard#flush} function will force the clipboard manager to flush the data.
+  # 
+  # === 
+  # 
+  # Category:  Clipboard and Drag & Drop
+  # @see Drag and Drop Overview
+  # @see  wxDataObject Overview
+  # @see  Wx::DataObject 
+  # 
+  # 
+  class Clipboard < Object
+  
+    # Default constructor.
+    # @return [Clipboard]
+    def initialize; end
+    
+    # Call this function to add the data object to the clipboard.
+    # This is an obsolete synonym for {Wx::Clipboard#set_data}.
+    # @param data [Wx::DataObject] 
+    # @return [true,false]
+    def add_data(data) end
+    
+    # Clears the global clipboard object and the system's clipboard if possible.
+    # @return [void]
+    def clear; end
+    
+    # Call this function to close the clipboard, having opened it with {Wx::Clipboard#open}.
+    # @return [void]
+    def close; end
+    
+    # Flushes the clipboard: this means that the data which is currently on clipboard will stay available even after the application exits (possibly eating memory), otherwise the clipboard will be emptied on exit.
+    # Currently this method is implemented in MSW and GTK and always returns false otherwise.
+    # On GTK, only the non-primary selection can be flushed. Calling this function when the clipboard is using the primary selection will return false and not make any data available after the program exits.
+    # 
+    # false if the operation is unsuccessful for any reason.
+    # @return [true,false]
+    def flush; end
+    
+    # Call this function to fill data with data on the clipboard, if available in the required format.
+    # Returns true on success.
+    # @param data [Wx::DataObject] 
+    # @return [true,false]
+    def get_data(data) end
+    alias_method :data, :get_data
+    
+    # Returns true if the clipboard has been opened.
+    # @return [true,false]
+    def is_opened; end
+    alias_method :opened?, :is_opened
+    
+    # Returns true if there is data which matches the data format of the given data object currently <b>available</b> on the clipboard.
+    # TodoThe name of this function is misleading. This should be renamed to something that more accurately indicates what it does.
+    # @param format [Wx::DataFormat] 
+    # @return [true,false]
+    def is_supported(format) end
+    alias_method :supported?, :is_supported
+    
+    # Returns true if we are using the primary selection, false if clipboard one.
+    # 
+    # @see Wx::Clipboard#use_primary_selection 
+    # @return [true,false]
+    def is_using_primary_selection; end
+    alias_method :using_primary_selection?, :is_using_primary_selection
+    
+    # Call this function to open the clipboard before calling {Wx::Clipboard#set_data} and {Wx::Clipboard#get_data}.
+    # Call {Wx::Clipboard#close} when you have finished with the clipboard. You should keep the clipboard open for only a very short time.
+    # true on success. This should be tested (as in the sample shown above).
+    # @return [true,false]
+    def open; end
+    
+    # Call this function to set the data object to the clipboard.
+    # The new data object replaces any previously set one, so if the application wants to provide clipboard data in several different formats, it must use a composite data object supporting all of the formats instead of calling this function several times with different data objects as this would only leave data from the last one in the clipboard.
+    # After this function has been called, the clipboard owns the data, so do not delete the data explicitly.
+    # @param data [Wx::DataObject] 
+    # @return [true,false]
+    def set_data(data) end
+    alias_method :data=, :set_data
+    
+    # On platforms supporting it (all X11-based ports), {Wx::Clipboard} uses the CLIPBOARD X11 selection by default.
+    # When this function is called with true, all subsequent clipboard operations will use PRIMARY selection until this function is called again with false.
+    # On the other platforms, there is no PRIMARY selection and so all clipboard operations will fail. This allows implementing the standard X11 handling of the clipboard which consists in copying data to the CLIPBOARD selection only when the user explicitly requests it (i.e. by selecting the "Copy" menu command) but putting the currently selected text into the PRIMARY selection automatically, without overwriting the normal clipboard contents with the currently selected text on the other platforms.
+    # @param primary [true,false] 
+    # @return [void]
+    def use_primary_selection(primary=false) end
+    
+    # Returns the global instance ({Wx::TheClipboard}) of the clipboard object.
+    # @return [Wx::Clipboard]
+    def self.get; end
+    
+  end # Clipboard
+  
+
+end