wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,299 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Allow only copying.
+  # 
+  Drag_CopyOnly = 0
+  
+  # Allow moving too (copying is always allowed).
+  # 
+  Drag_AllowMove = 1
+  
+  # Allow moving and make it default operation.
+  # 
+  Drag_DefaultMove = 3
+  
+  # Result returned from a {Wx::DropSource#do_drag_drop} call.
+  # 
+  # 
+  # 
+  # @wxrb_require USE_DRAG_AND_DROP
+  class DragResult < Wx::Enum
+  
+    # Error prevented the D&D operation from completing.
+    # 
+    DragError = Wx::DragResult.new(0)
+    
+    # Drag target didn't accept the data.
+    # 
+    DragNone = Wx::DragResult.new(1)
+    
+    # The data was successfully copied.
+    # 
+    DragCopy = Wx::DragResult.new(2)
+    
+    # The data was successfully moved (MSW only).
+    # 
+    DragMove = Wx::DragResult.new(3)
+    
+    # Operation is a drag-link.
+    # 
+    DragLink = Wx::DragResult.new(4)
+    
+    # The operation was cancelled by user (not an error).
+    # 
+    DragCancel = Wx::DragResult.new(5)
+    
+  end # DragResult
+  
+  # Returns true if res indicates that something was done during a DnD operation, i.e.
+  # 
+  # is neither error nor none nor cancel.
+  # @param res [Wx::DragResult] 
+  # @return [Boolean]
+  def self.is_drag_result_ok(res) end
+  
+  # This class represents a source for a drag and drop operation.
+  # 
+  # Category:  Clipboard and Drag & Drop
+  # @see Drag and Drop Overview
+  # @see  wxDataObject Overview
+  # @see  Wx::DropTarget
+  # @see  Wx::TextDropTarget
+  # @see  Wx::FileDropTarget 
+  # 
+  # 
+  # @wxrb_require USE_DRAG_AND_DROP
+  class DropSource < ::Object
+  
+    # @overload initialize(win=nil, iconCopy=Wx::NULL_ICON, iconMove=Wx::NULL_ICON, iconNone=Wx::NULL_ICON)
+    #   This constructor requires that you must call {Wx::DropSource#set_data} later.
+    #   
+    #   This is the WXGTK-specific version of the constructor taking {Wx::Icon} instead of {Wx::Cursor} as the other ports.
+    #   Availability:  only available for the WXGTK port.
+    #   @param win [Wx::Window]  The window which initiates the drag and drop operation.
+    #   @param iconCopy [Wx::Icon]  The icon or cursor used for feedback for copy operation.
+    #   @param iconMove [Wx::Icon]  The icon or cursor used for feedback for move operation.
+    #   @param iconNone [Wx::Icon]  The icon or cursor used for feedback when operation can't be done.
+    #   @return [Wx::DropSource]
+    #   @wxrb_require WXGTK
+    # @overload initialize(data, win=nil, iconCopy=Wx::NULL_ICON, iconMove=Wx::NULL_ICON, iconNone=Wx::NULL_ICON)
+    #   The constructor taking a {Wx::DataObject}.
+    #   
+    #   This is the WXGTK-specific version of the constructor taking {Wx::Icon} instead of {Wx::Cursor} as the other ports.
+    #   Availability:  only available for the WXGTK port.
+    #   @param data [Wx::DataObject]  The data associated with the drop source.
+    #   @param win [Wx::Window]  The window which initiates the drag and drop operation.
+    #   @param iconCopy [Wx::Icon]  The icon or cursor used for feedback for copy operation.
+    #   @param iconMove [Wx::Icon]  The icon or cursor used for feedback for move operation.
+    #   @param iconNone [Wx::Icon]  The icon or cursor used for feedback when operation can't be done.
+    #   @return [Wx::DropSource]
+    #   @wxrb_require WXGTK
+    def initialize(*args) end
+    
+    # Starts the drag-and-drop operation which will terminate when the user releases the mouse.
+    # 
+    # Call this in response to a mouse button press, for example.
+    # 
+    # The operation requested by the user, may be {Wx::DragResult::DragCopy}, {Wx::DragResult::DragMove}, {Wx::DragResult::DragLink}, {Wx::DragResult::DragCancel} or {Wx::DragResult::DragNone} if an error occurred.
+    # @param flags [Integer]  If {Wx::Drag_AllowMove} is included in the flags, data may be moved and not only copied as is the case for the default {Wx::Drag_CopyOnly}. If {Wx::Drag_DefaultMove} is specified (which includes the previous flag), moving is not only possible but becomes the default operation.
+    # @return [Wx::DragResult]
+    def do_drag_drop(flags=Wx::Drag_CopyOnly) end
+    
+    # Returns the {Wx::DataObject} object that has been assigned previously.
+    # @return [Wx::DataObject]
+    def get_data_object; end
+    alias_method :data_object, :get_data_object
+    
+    # You may give some custom UI feedback during the drag and drop operation by overriding this function.
+    # 
+    # It is called on each mouse move, so your implementation must not be too slow.
+    # 
+    # false if you want default feedback, or true if you implement your own feedback. The return value is ignored under GTK.
+    # @param effect [Wx::DragResult]  The effect to implement. One of {Wx::DragResult::DragCopy}, {Wx::DragResult::DragMove}, {Wx::DragResult::DragLink} and {Wx::DragResult::DragNone}.
+    # @return [Boolean]
+    def give_feedback(effect) end
+    
+    # Set the icon to use for a certain drag result.
+    # 
+    # Availability:  only available for the WXGTK port.
+    # @param res [Wx::DragResult]  The drag result to set the icon for.
+    # @param icon [Wx::Icon]  The icon to show when this drag result occurs.
+    # @return [void]
+    # @wxrb_require WXGTK
+    def set_icon(res, icon) end
+    
+    # Sets the data {Wx::DataObject} associated with the drop source.
+    # 
+    # This will not delete any previously associated data.
+    # @param data [Wx::DataObject] 
+    # @return [void]
+    def set_data(data) end
+    alias_method :data=, :set_data
+    
+  end # DropSource
+  
+  # This class represents a target for a drag and drop operation.
+  # 
+  # A {Wx::DataObject} can be associated with it and by default, this object will be filled with the data from the drag source, if the data formats supported by the data object match the drag source data format.
+  # There are various virtual handler functions defined in this class which may be overridden to give visual feedback or react in a more fine-tuned way, e.g. by not accepting data on the whole window area, but only a small portion of it. The normal sequence of calls is {Wx::DropTarget#on_enter}, {Wx::DropTarget#on_drag_over} possibly many times, {Wx::DropTarget#on_drop} and finally {Wx::DropTarget#on_data}.
+  # 
+  # Category:  Clipboard and Drag & Drop
+  # @see Drag and Drop Overview
+  # @see  wxDataObject Overview
+  # @see  Wx::DropSource
+  # @see  Wx::TextDropTarget
+  # @see  Wx::FileDropTarget
+  # @see  Wx::DataFormat
+  # @see  Wx::DataObject 
+  # 
+  # 
+  # @wxrb_require USE_DRAG_AND_DROP
+  class DropTarget < ::Object
+  
+    # Constructor.
+    # 
+    # data is the data to be associated with the drop target.
+    # @param data [Wx::DataObject] 
+    # @return [Wx::DropTarget]
+    def initialize(data=nil) end
+    
+    # This method may only be called from within {Wx::DropTarget#on_data}.
+    # 
+    # By default, this method copies the data from the drop source to the {Wx::DataObject} associated with this drop target, calling its {Wx::DataObject#set_data} method.
+    # @return [Boolean]
+    def get_data; end
+    alias_method :data, :get_data
+    
+    # Called after {Wx::DropTarget#on_drop} returns true.
+    # 
+    # By default this will usually {Wx::DropTarget#get_data} and will return the suggested default value defResult.
+    # @param x [Integer] 
+    # @param y [Integer] 
+    # @param defResult [Wx::DragResult] 
+    # @return [Wx::DragResult]
+    def on_data(x, y, defResult) end
+    
+    # Called when the mouse is being dragged over the drop target.
+    # 
+    # By default, this calls functions return the suggested return value defResult.
+    # 
+    # The desired operation or {Wx::DragResult::DragNone}. This is used for optical feedback from the side of the drop source, typically in form of changing the icon.
+    # @param x [Integer]  The x coordinate of the mouse.
+    # @param y [Integer]  The y coordinate of the mouse.
+    # @param defResult [Wx::DragResult]  Suggested value for return value. Determined by SHIFT or CONTROL key states.
+    # @return [Wx::DragResult]
+    def on_drag_over(x, y, defResult) end
+    
+    # Called when the user drops a data object on the target.
+    # 
+    # Return false to veto the operation.
+    # 
+    # true to accept the data, or false to veto the operation.
+    # @param x [Integer]  The x coordinate of the mouse.
+    # @param y [Integer]  The y coordinate of the mouse.
+    # @return [Boolean]
+    def on_drop(x, y) end
+    
+    # Called when the mouse enters the drop target.
+    # 
+    # By default, this calls {Wx::DropTarget#on_drag_over}.
+    # 
+    # The desired operation or {Wx::DragResult::DragNone}. This is used for optical feedback from the side of the drop source, typically in form of changing the icon.
+    # @param x [Integer]  The x coordinate of the mouse.
+    # @param y [Integer]  The y coordinate of the mouse.
+    # @param defResult [Wx::DragResult]  Suggested default for return value. Determined by SHIFT or CONTROL key states.
+    # @return [Wx::DragResult]
+    def on_enter(x, y, defResult) end
+    
+    # Called when the mouse leaves the drop target.
+    # @return [void]
+    def on_leave; end
+    
+    # Returns the data {Wx::DataObject} associated with the drop target.
+    # @return [Wx::DataObject]
+    def get_data_object; end
+    alias_method :data_object, :get_data_object
+    
+    # Sets the data {Wx::DataObject} associated with the drop target and deletes any previously associated data object.
+    # @param data [Wx::DataObject] 
+    # @return [void]
+    def set_data_object(data) end
+    alias_method :data_object=, :set_data_object
+    
+    # Sets the default action for drag and drop.
+    # 
+    # Use {Wx::DragResult::DragMove} or {Wx::DragResult::DragCopy} to set default action to move or copy and use {Wx::DragResult::DragNone} (default) to set default action specified by initialization of dragging (see {Wx::DropSource#do_drag_drop})
+    # @param action [Wx::DragResult] 
+    # @return [void]
+    def set_default_action(action) end
+    alias_method :default_action=, :set_default_action
+    
+    # Returns default action for drag and drop or {Wx::DragResult::DragNone} if this not specified.
+    # @return [Wx::DragResult]
+    def get_default_action; end
+    alias_method :default_action, :get_default_action
+    
+  end # DropTarget
+  
+  # This is a drop target which accepts files (dragged from File Manager or Explorer).
+  # 
+  # Category:  Clipboard and Drag & Drop
+  # @see Drag and Drop Overview
+  # @see  Wx::DropSource
+  # @see  Wx::DropTarget
+  # @see  Wx::TextDropTarget 
+  # 
+  # 
+  # @wxrb_require USE_DRAG_AND_DROP
+  class FileDropTarget < DropTarget
+  
+    # Constructor.
+    # @return [Wx::FileDropTarget]
+    def initialize; end
+    
+    # Override this function to receive dropped files.
+    # 
+    # Return true to accept the data, or false to veto the operation.
+    # @param x [Integer]  The x coordinate of the mouse.
+    # @param y [Integer]  The y coordinate of the mouse.
+    # @param filenames [Array<String>]  An array of filenames.
+    # @return [Boolean]
+    def on_drop_files(x, y, filenames) end
+    
+  end # FileDropTarget
+  
+  # A predefined drop target for dealing with text data.
+  # 
+  # Category:  Clipboard and Drag & Drop
+  # @see Drag and Drop Overview
+  # @see  Wx::DropSource
+  # @see  Wx::DropTarget
+  # @see  Wx::FileDropTarget 
+  # 
+  # 
+  # @wxrb_require USE_DRAG_AND_DROP
+  class TextDropTarget < DropTarget
+  
+    # Constructor.
+    # @return [Wx::TextDropTarget]
+    def initialize; end
+    
+    # Override this function to receive dropped text.
+    # 
+    # Return true to accept the data, or false to veto the operation.
+    # @param x [Integer]  The x coordinate of the mouse.
+    # @param y [Integer]  The y coordinate of the mouse.
+    # @param data [String]  The data being dropped: a {Wx::String}.
+    # @return [Boolean]
+    def on_drop_text(x, y, data) end
+    
+  end # TextDropTarget
+  
+
+end

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

@@ -0,0 +1,116 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This class is used when you wish to drag an object on the screen, and a simple cursor is not enough.
+  # 
+  # On Windows, the Win32 API is used to achieve smooth dragging. On other platforms, {Wx::GenericDragImage} is used. Applications may also prefer to use {Wx::GenericDragImage} on Windows, too.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>{Wx::GenericDragImage} implementation uses {Wx::ScreenDC} and so doesn't work on the platforms where {Wx::ScreenDC} doesn't work, e.g. modern macOS versions.
+  # </p>
+  # </div>
+  # 
+  # To use this class, when you wish to start dragging an image, create a {Wx::DragImage} object and store it somewhere you can access it as the drag progresses. Call {Wx::DragImage#begin_drag} to start, and {Wx::DragImage#end_drag} to stop the drag. To move the image, initially call {Wx::DragImage#show} and then {Wx::DragImage#move}. If you wish to update the screen contents during the drag (for example, highlight an item as in the dragimag sample), first call {Wx::DragImage#hide}, update the screen, call {Wx::DragImage#move}, and then call {Wx::DragImage#show}.
+  # You can drag within one window, or you can use full-screen dragging either across the whole screen, or just restricted to one area of the screen to save resources. If you want the user to drag between two windows, then you will need to use full-screen dragging.
+  # If you wish to draw the image yourself, use {Wx::GenericDragImage} and override {Wx::DragImage#do_draw_image} and {Wx::DragImage#get_image_rect}.
+  # 
+  # Category:  Clipboard and Drag & Drop
+  # @see page_samples_dragimag 
+  # 
+  # 
+  # @wxrb_require USE_DRAGIMAGE
+  class DragImage < Object
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Wx::DragImage]
+    # @overload initialize(image, cursor=Wx::NULL_CURSOR)
+    #   Constructs a drag image from a bitmap and optional cursor.
+    #   @param image [Wx::Bitmap]  Bitmap to be used as the drag image. The bitmap can have a mask.
+    #   @param cursor [Wx::Cursor]  Optional cursor to combine with the image.
+    #   @return [Wx::DragImage]
+    # @overload initialize(image, cursor=Wx::NULL_CURSOR)
+    #   Constructs a drag image from an icon and optional cursor.
+    #   @param image [Wx::Icon]  Icon to be used as the drag image.
+    #   @param cursor [Wx::Cursor]  Optional cursor to combine with the image.
+    #   @return [Wx::DragImage]
+    # @overload initialize(text, cursor=Wx::NULL_CURSOR)
+    #   Constructs a drag image from a text string and optional cursor.
+    #   @param text [String]  Text used to construct a drag image.
+    #   @param cursor [Wx::Cursor]  Optional cursor to combine with the image.
+    #   @return [Wx::DragImage]
+    # @overload initialize(treeCtrl, id)
+    #   Constructs a drag image from the text in the given tree control item, and optional cursor.
+    #   @param treeCtrl [Wx::TreeCtrl]  Tree control for constructing a tree drag image.
+    #   @param id [Wx::TreeItemId]  Tree control item id.
+    #   @return [Wx::DragImage]
+    # @overload initialize(listCtrl, id)
+    #   Constructs a drag image from the text in the given list control item, and optional cursor.
+    #   @param listCtrl [Wx::ListCtrl]  List control for constructing a list drag image.
+    #   @param id [Integer]  List control item id.
+    #   @return [Wx::DragImage]
+    def initialize(*args) end
+    
+    # @overload begin_drag(hotspot, window, fullScreen=false, rect=nil)
+    #   Start dragging the image, in a window or full screen.
+    #   
+    #   You need to then call {Wx::DragImage#show} and {Wx::DragImage#move} to show the image on the screen. Call {Wx::DragImage#end_drag} when the drag has finished.
+    #   Note that this call automatically calls CaptureMouse().
+    #   @param hotspot [Array(Integer, Integer), Wx::Point]  The location of the drag position relative to the upper-left corner of the image.
+    #   @param window [Wx::Window]  The window that captures the mouse, and within which the dragging is limited unless fullScreen is true.
+    #   @param fullScreen [Boolean]  If true, specifies that the drag will be visible over the full screen, or over as much of the screen as is specified by rect. Note that the mouse will still be captured in window.
+    #   @param rect [Wx::Rect]  If non-null, specifies the rectangle (in screen coordinates) that bounds the dragging operation. Specifying this can make the operation more efficient by cutting down on the area under consideration, and it can also make a visual difference since the drag is clipped to this area.
+    #   @return [Boolean]
+    # @overload begin_drag(hotspot, window, boundingWindow)
+    #   Start dragging the image, using the first window to capture the mouse and the second to specify the bounding area.
+    #   
+    #   This form is equivalent to using the first form, but more convenient than working out the bounding rectangle explicitly.
+    #   You need to then call {Wx::DragImage#show} and {Wx::DragImage#move} to show the image on the screen. Call {Wx::DragImage#end_drag} when the drag has finished.
+    #   Note that this call automatically calls CaptureMouse().
+    #   @param hotspot [Array(Integer, Integer), Wx::Point]  The location of the drag position relative to the upper-left corner of the image.
+    #   @param window [Wx::Window]  The window that captures the mouse, and within which the dragging is limited.
+    #   @param boundingWindow [Wx::Window]  Specifies the area within which the drag occurs.
+    #   @return [Boolean]
+    def begin_drag(*args) end
+    
+    # Call this when the drag has finished.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This function automatically releases mouse capture. 
+    # </p>
+    # </div>
+    # @return [Boolean]
+    def end_drag; end
+    
+    # Hides the image.
+    # 
+    # You may wish to call this before updating the window contents (perhaps highlighting an item). Then call {Wx::DragImage#move} and {Wx::DragImage#show}.
+    # @return [Boolean]
+    def hide; end
+    
+    # Call this to move the image to a new position.
+    # 
+    # The image will only be shown if {Wx::DragImage#show} has been called previously (for example at the start of the drag).
+    # 
+    # You can move the image either when the image is hidden or shown, but in general dragging will be smoother if you move the image when it is shown.
+    # @param pt [Array(Integer, Integer), Wx::Point]  The position in client coordinates (relative to the window specified in {Wx::DragImage#begin_drag}).
+    # @return [Boolean]
+    def move(pt) end
+    
+    # Shows the image.
+    # 
+    # Call this at least once when dragging.
+    # @return [Boolean]
+    def show; end
+    
+  end # DragImage
+  
+
+end

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

@@ -0,0 +1,109 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  EL_ALLOW_NEW = 256
+  
+  # 
+  EL_ALLOW_EDIT = 512
+  
+  # 
+  EL_ALLOW_DELETE = 1024
+  
+  # 
+  EL_NO_REORDER = 2048
+  
+  # 
+  EL_DEFAULT_STYLE = 1792
+  
+  # An editable listbox is composite control that lets the user easily enter, delete and reorder a list of strings.
+  # 
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::EL_ALLOW_NEW}: Allows the user to enter new strings (implies {Wx::EL_ALLOW_EDIT} as well). 
+  # 
+  # - {Wx::EL_ALLOW_EDIT}: Allows the user to edit existing strings. 
+  # 
+  # - {Wx::EL_ALLOW_DELETE}: Allows the user to delete existing strings. 
+  # 
+  # - {Wx::EL_NO_REORDER}: Does not allow the user to reorder the strings. 
+  # 
+  # - {Wx::EL_DEFAULT_STYLE}: Default style: {Wx::EL_ALLOW_NEW}|{Wx::EL_ALLOW_EDIT}|{Wx::EL_ALLOW_DELETE}. 
+  # 
+  # The control uses a {Wx::ListCtrl} internally and emit its events.
+  # 
+  # Category:  {Wx::Controls}
+  # @see Wx::ListBox
+  # @see  Wx::ListCtrl 
+  # 
+  # 
+  # @wxrb_require USE_EDITABLELISTBOX
+  class EditableListBox < Panel
+  
+    # @overload initialize()
+    #   Default ctor.
+    #   @return [Wx::EditableListBox]
+    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::EL_DEFAULT_STYLE, name=Wx::EDITABLE_LIST_BOX_NAME_STR)
+    #   Constructor, creating and showing a list box.
+    #   
+    #   
+    #   @see Wx::EditableListBox#create 
+    #   @param parent [Wx::Window]  Parent window. Must not be nil.
+    #   @param id [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param label [String]  The text shown just before the list control.
+    #   @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 style [Integer]  Window style. See {Wx::EditableListBox}.
+    #   @param name [String]  Window name.
+    #   @return [Wx::EditableListBox]
+    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::EL_DEFAULT_STYLE, name=Wx::EDITABLE_LIST_BOX_NAME_STR, &block)
+    #   Constructor, creating and showing a list box.
+    #   
+    #   
+    #   @see Wx::EditableListBox#create 
+    #   @param parent [Wx::Window]  Parent window. Must not be nil.
+    #   @param id [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param label [String]  The text shown just before the list control.
+    #   @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 style [Integer]  Window style. See {Wx::EditableListBox}.
+    #   @param name [String]  Window name.
+    #   @yieldparam [Wx::EditableListBox] win new instance
+    #   @return [Wx::EditableListBox]
+    def initialize(*args) end
+    
+    # Creates the editable listbox for two-step construction.
+    # 
+    # See {Wx::EditableListBox#initialize} for further 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 name [String] 
+    # @return [Boolean]
+    def create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::EL_DEFAULT_STYLE, name=Wx::EDITABLE_LIST_BOX_NAME_STR) end
+    
+    # Replaces current contents with given strings.
+    # @param strings [Array<String>] 
+    # @return [void]
+    def set_strings(strings) end
+    alias_method :strings=, :set_strings
+    
+    # Returns in the given array the current contents of the control (the array will be erased before control's contents are appended).
+    # @return [Array<String>]
+    def get_strings; end
+    alias_method :strings, :get_strings
+    
+  end # EditableListBox
+  
+
+end