wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,352 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  FRAME_NO_TASKBAR = 2
+  
+  # 
+  FRAME_TOOL_WINDOW = 4
+  
+  # 
+  FRAME_FLOAT_ON_PARENT = 8
+  
+  # A frame is a window whose size and position can (usually) be changed by the user.
+  # 
+  # It usually has thick borders and a title bar, and can optionally contain a menu bar, toolbar and status bar. A frame can contain any window that is not a frame or dialog.
+  # A frame that has a status bar and toolbar, created via the {Wx::Frame#create_status_bar} and {Wx::Frame#create_tool_bar} functions, manages these windows and adjusts the value returned by {Wx::Frame#get_client_size} to reflect the remaining size available to application windows.
+  # If a frame is to be used as an input form, the controls should not be created as its children. Instead, a {Wx::Panel} should be created as the sole child of the frame, serving as the parent of the actual controls (the frame will size the panel so it always fills its client area). Doing this will ensure that tabbing between the controls works and the frame background has the expected colour. Moreover, as a frame is by default resizable, it could be better to use {Wx::ScrolledWindow} instead of {Wx::Panel}, to make sure the controls are easily accessible regardless of the frame size. However, please consider whether it would not be better to use {Wx::Dialog} instead of {Wx::Frame}, where using a panel like this is not needed and {Wx::Dialog} also offers other benefits such as creating specialized sizers (e.g., for buttons, with their platform-correct order).
+  # 
+  # <div class="wxrb-remark">
+  # <b>Remark:</b>
+  # <p>An application should normally define a {Wx::CloseEvent} handler for the frame to respond to system close events, for example so that related data and subwindows can be cleaned up.
+  # </p>
+  # </div>
+  # 
+  # ## Default event processing
+  # {Wx::Frame} processes the following events:
+  # 
+  # - {Wx::EVT_SIZE}: if the frame has exactly one child window, not counting the status and toolbar, this child is resized to take the entire frame client area. If two or more windows are present, they should be laid out explicitly either by manually handling {Wx::EVT_SIZE} or using sizers; 
+  # 
+  # - {Wx::EVT_MENU_HIGHLIGHT}: the default implementation displays the help string associated with the selected item in the first pane of the status bar, if there is one.
+  # 
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::DEFAULT_FRAME_STYLE}: Defined as {Wx::MINIMIZE_BOX} | {Wx::MAXIMIZE_BOX} | {Wx::RESIZE_BORDER} | {Wx::SYSTEM_MENU} | {Wx::CAPTION} | {Wx::CLOSE_BOX} | {Wx::CLIP_CHILDREN}. 
+  # 
+  # - {Wx::ICONIZE}: Display the frame iconized (minimized). Windows only. 
+  # 
+  # - {Wx::CAPTION}: Shows the title bar, containing the window title, for this window. Note that this style is implicitly enabled by {Wx::MINIMIZE_BOX}, {Wx::MAXIMIZE_BOX} and {Wx::CLOSE_BOX} on most systems as the corresponding buttons couldn't be shown if the window had no title bar at all. 
+  # 
+  # - {Wx::MINIMIZE}: Identical to {Wx::ICONIZE}. Windows only. 
+  # 
+  # - {Wx::MINIMIZE_BOX}: Displays a minimize box on the frame. This style implicitly enables {Wx::CAPTION} too. 
+  # 
+  # - {Wx::MAXIMIZE}: Displays the frame maximized. Windows and GTK+ only. 
+  # 
+  # - {Wx::MAXIMIZE_BOX}: Displays a maximize box on the frame. Notice that under WXGTK {Wx::RESIZE_BORDER} must be used as well or this style is ignored. This style implicitly enables {Wx::CAPTION} too. 
+  # 
+  # - {Wx::CLOSE_BOX}: Displays a close box on the frame. This style implicitly enables {Wx::CAPTION} too. 
+  # 
+  # - {Wx::STAY_ON_TOP}: Stay on top of all other windows, see also {Wx::FRAME_FLOAT_ON_PARENT}. 
+  # 
+  # - {Wx::SYSTEM_MENU}: Displays a system menu containing the list of various windows commands in the window title bar. Unlike {Wx::MINIMIZE_BOX}, {Wx::MAXIMIZE_BOX} and {Wx::CLOSE_BOX} styles this style doesn't turn on {Wx::CAPTION} under MSW and if it's not specified, makes the system menu available without showing it on screen in this case. However it is recommended to only use it together with {Wx::CAPTION} for consistent behaviour under all platforms. 
+  # 
+  # - {Wx::RESIZE_BORDER}: Displays a resizable border around the window. 
+  # 
+  # - {Wx::FRAME_TOOL_WINDOW}: Causes a frame with a small title bar to be created; the frame does not appear in the taskbar under Windows or GTK+. 
+  # 
+  # - {Wx::FRAME_NO_TASKBAR}: Creates an otherwise normal frame but it does not appear in the taskbar under Windows or GTK+ (note that it will minimize to the desktop window under Windows which may seem strange to the users and thus it might be better to use this style only without {Wx::MINIMIZE_BOX} style). In WXGTK, the flag is respected only if the window manager supports _NET_WM_STATE_SKIP_TASKBAR hint. 
+  # 
+  # - {Wx::FRAME_FLOAT_ON_PARENT}: The frame will always be on top of its parent (unlike {Wx::STAY_ON_TOP}). A frame created with this style must have a non-null parent. 
+  # 
+  # - {Wx::FRAME_SHAPED}: Windows with this style are allowed to have their shape changed with the {Wx::Frame#set_shape} method. 
+  # 
+  # The default frame style is for normal, resizable frames. To create a frame which cannot be resized by user, you may use the following combination of styles:
+  # 
+  # ```ruby
+  #   Wx::DEFAULT_FRAME_STYLE & ~(Wx::RESIZE_BORDER | Wx::MAXIMIZE_BOX)
+  # ```
+  # 
+  # See also the Window Styles.
+  # 
+  # ### Extra Styles
+  # 
+  # This class supports the following extra styles:
+  # 
+  # - {Wx::FRAME_EX_CONTEXTHELP}: Under Windows, puts a query button on the caption. When pressed, Windows will go into a context-sensitive help mode and wxWidgets will send a {Wx::EVT_HELP} event if the user clicked on an application window. Note that this is an extended style and must be set by calling SetExtraStyle before Create is called (two-step construction). You cannot use this style together with {Wx::MAXIMIZE_BOX} or {Wx::MINIMIZE_BOX}, so you should use {Wx::DEFAULT_FRAME_STYLE} ~ ({Wx::MINIMIZE_BOX} | {Wx::MAXIMIZE_BOX}) for the frames having this style (the dialogs don't have a minimize or a maximize box by default) 
+  # 
+  # - {Wx::FRAME_EX_METAL}: On macOS, frames with this style will be shown with a metallic look. This is an extra style. Note that this is deprecated after macOS 10.12. 
+  # 
+  # ### Events emitted by this class
+  # 
+  # Event handler methods for events emitted by this class:
+  # 
+  # - {Wx::EvtHandler#evt_close}(meth = nil, &block): Process a {Wx::EVT_CLOSE_WINDOW} event when the frame is being closed by the user or programmatically (see {Wx::Window#close}). The user may generate this event clicking the close button (typically the 'X' on the top-right of the title bar) if it's present (see the {Wx::CLOSE_BOX} style). See {Wx::CloseEvent}. 
+  # 
+  # - {Wx::EvtHandler#evt_iconize}(meth = nil, &block): Process a {Wx::EVT_ICONIZE} event. See {Wx::IconizeEvent}. 
+  # 
+  # - {Wx::EvtHandler#evt_menu_open}(meth = nil, &block): A menu is about to be opened. See {Wx::MenuEvent}. 
+  # 
+  # - {Wx::EvtHandler#evt_menu_close}(meth = nil, &block): A menu has been just closed. See {Wx::MenuEvent}. 
+  # 
+  # - {Wx::EvtHandler#evt_menu_highlight}(id, meth = nil, &block): The menu item with the specified id has been highlighted: used to show help prompts in the status bar by {Wx::Frame}. See {Wx::MenuEvent}. 
+  # 
+  # - {Wx::EvtHandler#evt_menu_highlight_all}(meth = nil, &block): A menu item has been highlighted, i.e. the currently selected menu item has changed. See {Wx::MenuEvent}. 
+  # 
+  # Category:  Managed Windows
+  # @see Wx::MDIParentFrame
+  # @see  Wx::MDIChildFrame
+  # @see  Wx::MiniFrame
+  # @see  Wx::Dialog 
+  # 
+  # 
+  class Frame < TopLevelWindow
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Wx::Frame]
+    # @overload initialize(parent, id, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_FRAME_STYLE, name=Wx::FRAME_NAME_STR)
+    #   Constructor, creating the window.
+    #   
+    #   
+    #   @see Wx::Frame#create 
+    #   @param parent [Wx::Window]  The window parent. This may be, and often is, nil. If it is non-null, the frame will be minimized when its parent is minimized and restored when it is restored (although it will still be possible to minimize and restore just this frame itself).
+    #   @param id [Integer]  The window identifier. It may take a value of -1 to indicate a default value.
+    #   @param title [String]  The caption to be displayed on the frame's title bar.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  The window position. The value {Wx::DEFAULT_POSITION} indicates a default position, chosen by either the windowing system or wxWidgets, depending on platform.
+    #   @param size [Array(Integer, Integer), Wx::Size]  The window size. The value {Wx::DEFAULT_SIZE} indicates a default size, chosen by either the windowing system or wxWidgets, depending on platform.
+    #   @param style [Integer]  The window style. See {Wx::Frame} class description.
+    #   @param name [String]  The name of the window. This parameter is used to associate a name with the window. This is not the same as the title of the window.
+    #   @return [Wx::Frame]
+    # @overload initialize(parent, id, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_FRAME_STYLE, name=Wx::FRAME_NAME_STR, &block)
+    #   Constructor, creating the window.
+    #   
+    #   
+    #   @see Wx::Frame#create 
+    #   @param parent [Wx::Window]  The window parent. This may be, and often is, nil. If it is non-null, the frame will be minimized when its parent is minimized and restored when it is restored (although it will still be possible to minimize and restore just this frame itself).
+    #   @param id [Integer]  The window identifier. It may take a value of -1 to indicate a default value.
+    #   @param title [String]  The caption to be displayed on the frame's title bar.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  The window position. The value {Wx::DEFAULT_POSITION} indicates a default position, chosen by either the windowing system or wxWidgets, depending on platform.
+    #   @param size [Array(Integer, Integer), Wx::Size]  The window size. The value {Wx::DEFAULT_SIZE} indicates a default size, chosen by either the windowing system or wxWidgets, depending on platform.
+    #   @param style [Integer]  The window style. See {Wx::Frame} class description.
+    #   @param name [String]  The name of the window. This parameter is used to associate a name with the window. This is not the same as the title of the window.
+    #   @yieldparam [Wx::Frame] win new instance
+    #   @return [Wx::Frame]
+    def initialize(*args) end
+    
+    # Centres the frame on the display.
+    # @param direction [Integer]  The parameter may be {Wx::Orientation::HORIZONTAL}, {Wx::Orientation::VERTICAL} or {Wx::Orientation::BOTH}.
+    # @return [void]
+    def centre(direction=Wx::Orientation::BOTH) end
+    
+    # Used in two-step frame construction.
+    # 
+    # See {Wx::Frame#initialize} for further details.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param title [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, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_FRAME_STYLE, name=Wx::FRAME_NAME_STR) end
+    
+    # Creates a status bar at the bottom of the frame.
+    # 
+    # A pointer to the status bar if it was created successfully, nil otherwise.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>The width of the status bar is the whole width of the frame (adjusted automatically when resizing), and the height and text size are chosen by the host windowing system.
+    # </p>
+    # </div>
+    # @see Wx::Frame#set_status_text
+    # @see  Wx::Frame#on_create_status_bar
+    # @see  Wx::Frame#get_status_bar 
+    # @param number [Integer]  The number of fields to create. Specify a value greater than 1 to create a multi-field status bar.
+    # @param style [Integer]  The status bar style. See {Wx::StatusBar} for a list of valid styles.
+    # @param id [Integer]  The status bar window identifier. If -1, an identifier will be chosen by wxWidgets.
+    # @param name [String]  The status bar window name.
+    # @return [Wx::StatusBar]
+    def create_status_bar(number=1, style=Wx::STB_DEFAULT_STYLE, id=0, name=Wx::STATUS_BAR_NAME_STR) end
+    
+    # Creates a toolbar at the top or left of the frame.
+    # 
+    # A pointer to the toolbar if it was created successfully, nil otherwise.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>By default, the toolbar is an instance of {Wx::ToolBar}. To use a different class, override {Wx::Frame#on_create_tool_bar}. When a toolbar has been created with this function, or made known to the frame with {Wx::Frame#set_tool_bar}, the frame will manage the toolbar position and adjust the return value from {Wx::Window#get_client_size} to reflect the available space for application windows. Under Pocket PC, you should always use this function for creating the toolbar to be managed by the frame, so that wxWidgets can use a combined menubar and toolbar. Where you manage your own toolbars, create a {Wx::ToolBar} as usual.
+    # </p>
+    # </div>
+    # @see Wx::Frame#create_status_bar
+    # @see  Wx::Frame#on_create_tool_bar
+    # @see  Wx::Frame#set_tool_bar
+    # @see  Wx::Frame#get_tool_bar 
+    # @param style [Integer]  The toolbar style. See {Wx::ToolBar} for a list of valid styles.
+    # @param id [Integer]  The toolbar window identifier. If -1, an identifier will be chosen by wxWidgets.
+    # @param name [String]  The toolbar window name.
+    # @return [Wx::ToolBar]
+    def create_tool_bar(style=Wx::TB_DEFAULT_STYLE, id=Wx::StandardID::ID_ANY, name=Wx::TOOL_BAR_NAME_STR) end
+    
+    # Method used to show help string of the selected menu toolbar item.
+    # 
+    # This method is called by the default {Wx::EVT_MENU_HIGHLIGHT} event handler and also by {Wx::ToolBar} to show the optional help string associated with the selected menu or toolbar item. It can be overridden if the default behaviour of showing this string in the frame status bar is not appropriate.
+    # @see Wx::Frame#set_status_bar_pane 
+    # @param text [String]  The help string to show, may be empty. The default implementation simply shows this string in the frame status bar (after remembering its previous text to restore it later).
+    # @param show [Boolean]  Whether the help should be shown or hidden. The default implementation restores the previously saved status bar text when it is false.
+    # @return [void]
+    def do_give_help(text, show) end
+    
+    # Returns the origin of the frame client area (in client coordinates).
+    # 
+    # It may be different from (0, 0) if the frame has a toolbar.
+    # @return [Wx::Point]
+    def get_client_area_origin; end
+    alias_method :client_area_origin, :get_client_area_origin
+    
+    # Set the frame modality.
+    # 
+    # Call this function before showing the frame to make it modal to the application ({Wx::WindowMode::AppModal}) or just to the parent window ({Wx::WindowMode::WindowModal}).
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Changing the frame modality after it has been shown has no effect
+    # </p>
+    # </div>
+    # @param modality [Wx::WindowMode] 
+    # @return [void]
+    def set_window_modality(modality) end
+    alias_method :window_modality=, :set_window_modality
+    
+    # Returns a pointer to the menubar currently associated with the frame (if any).
+    # 
+    # 
+    # @see Wx::Frame#set_menu_bar
+    # @see  Wx::MenuBar
+    # @see  Wx::Menu 
+    # @return [Wx::MenuBar]
+    def get_menu_bar; end
+    alias_method :menu_bar, :get_menu_bar
+    
+    # Returns a pointer to the status bar currently associated with the frame (if any).
+    # 
+    # 
+    # @see Wx::Frame#create_status_bar
+    # @see  Wx::StatusBar 
+    # @return [Wx::StatusBar]
+    def get_status_bar; end
+    alias_method :status_bar, :get_status_bar
+    
+    # Returns the status bar pane used to display menu and toolbar help.
+    # 
+    # 
+    # @see Wx::Frame#set_status_bar_pane 
+    # @return [Integer]
+    def get_status_bar_pane; end
+    alias_method :status_bar_pane, :get_status_bar_pane
+    
+    # Returns a pointer to the toolbar currently associated with the frame (if any).
+    # 
+    # 
+    # @see Wx::Frame#create_tool_bar
+    # @see  Wx::ToolBar
+    # @see  Wx::Frame#set_tool_bar 
+    # @return [Wx::ToolBar]
+    def get_tool_bar; end
+    alias_method :tool_bar, :get_tool_bar
+    
+    # Simulate a menu command.
+    # @param id [Integer]  The identifier for a menu item.
+    # @return [Boolean]
+    def process_command(id) end
+    
+    # Tells the frame to show the given menu bar.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>If the frame is destroyed, the menu bar and its menus will be destroyed also, so do not delete the menu bar explicitly (except by resetting the frame's menu bar to another frame or nil). Under Windows, a size event is generated, so be sure to initialize data members properly before calling {Wx::Frame#set_menu_bar}. Note that on some platforms, it is not possible to call this function twice for the same frame object.
+    # </p>
+    # </div>
+    # @see Wx::Frame#get_menu_bar
+    # @see  Wx::MenuBar
+    # @see  Wx::Menu. 
+    # @param menuBar [Wx::MenuBar]  The menu bar to associate with the frame.
+    # @return [void]
+    def set_menu_bar(menuBar) end
+    alias_method :menu_bar=, :set_menu_bar
+    
+    # Associates a status bar with the frame.
+    # 
+    # If statusBar is nil, then the status bar, if present, is detached from the frame, but not deleted.
+    # @see Wx::Frame#create_status_bar
+    # @see  Wx::StatusBar
+    # @see  Wx::Frame#get_status_bar 
+    # @param statusBar [Wx::StatusBar] 
+    # @return [void]
+    def set_status_bar(statusBar) end
+    alias_method :status_bar=, :set_status_bar
+    
+    # Set the status bar pane used to display menu and toolbar help.
+    # 
+    # Using -1 disables help display.
+    # @param n [Integer] 
+    # @return [void]
+    def set_status_bar_pane(n) end
+    alias_method :status_bar_pane=, :set_status_bar_pane
+    
+    # Sets the status bar text and updates the status bar display.
+    # 
+    # This is a simple wrapper for {Wx::StatusBar#set_status_text} which doesn't do anything if the frame has no status bar, i.e. {Wx::Frame#get_status_bar} returns nil.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Use an empty string to clear the status bar.
+    # </p>
+    # </div>
+    # @see Wx::Frame#create_status_bar
+    # @see  Wx::StatusBar 
+    # @param text [String]  The text for the status field.
+    # @param number [Integer]  The status field (starting from zero).
+    # @return [void]
+    def set_status_text(text, number=0) end
+    alias_method :status_text=, :set_status_text
+    
+    # Sets the widths of the fields in the status bar.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>The widths of the variable fields are calculated from the total width of all fields, minus the sum of widths of the non-variable fields, divided by the number of variable fields.
+    # </p>
+    # </div>
+    # @param widths_field [Array<Integer>]  Must contain an array of n integers, each of which is a status field width in pixels. A value of -1 indicates that the field is variable width; at least one field must be -1. You should delete this array after calling {Wx::Frame#set_status_widths}.
+    # @return [void]
+    def set_status_widths(widths_field) end
+    
+    # Associates a toolbar with the frame.
+    # @param toolBar [Wx::ToolBar] 
+    # @return [void]
+    def set_tool_bar(toolBar) end
+    alias_method :tool_bar=, :set_tool_bar
+    
+    # @param text [String] 
+    # @param number [Integer] 
+    # @return [void]
+    def push_status_text(text, number=0) end
+    
+    # @param number [Integer] 
+    # @return [void]
+    def pop_status_text(number=0) end
+    
+  end # Frame
+  
+
+end

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

@@ -0,0 +1,337 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Open Bit Flags.
+  # 
+  # 
+  # 
+  # @wxrb_require USE_FILESYSTEM
+  class FileSystemOpenFlags < Wx::Enum
+  
+    # Open for reading.
+    # 
+    FS_READ = Wx::FileSystemOpenFlags.new(1)
+    
+    # Returned stream will be seekable.
+    # 
+    FS_SEEKABLE = Wx::FileSystemOpenFlags.new(4)
+    
+  end # FileSystemOpenFlags
+  
+  # Parameter indicating how file offset should be interpreted.
+  # 
+  # @wxrb_require USE_FILESYSTEM
+  class SeekMode < Wx::Enum
+  
+    # Seek from the file beginning.
+    # 
+    FromStart = Wx::SeekMode.new(0)
+    
+    # Seek from the current position.
+    # 
+    FromCurrent = Wx::SeekMode.new(1)
+    
+    # Seek from end of the file.
+    # 
+    FromEnd = Wx::SeekMode.new(2)
+    
+  end # SeekMode
+  
+  # IO stream error codes.
+  # 
+  # @wxrb_require USE_FILESYSTEM
+  class StreamError < Wx::Enum
+  
+    # No error occurred.
+    # 
+    STREAM_NO_ERROR = Wx::StreamError.new(0)
+    
+    # EOF reached.
+    # 
+    STREAM_EOF = Wx::StreamError.new(1)
+    
+    # generic write error on the last write call.
+    # 
+    STREAM_WRITE_ERROR = Wx::StreamError.new(2)
+    
+    # generic read error on the last read call.
+    # 
+    STREAM_READ_ERROR = Wx::StreamError.new(3)
+    
+  end # StreamError
+  
+  # This class represents a single file opened by {Wx::FileSystem}.
+  # 
+  # It provides more information than wxWidgets' input streams (stream, filename, mime type, anchor).
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>Any pointer returned by a method of {Wx::FSFile} is valid only as long as the {Wx::FSFile} object exists. For example a call to {Wx::FSFile#get_stream} doesn't create the stream but only returns the pointer to it. In other words after 10 calls to {Wx::FSFile#get_stream} you will have obtained ten identical pointers.
+  # </p>
+  # </div>
+  # 
+  # Category:  Virtual File System, File Handling
+  # @see Wx::FileSystemHandler
+  # @see  Wx::FileSystem
+  # @see  wxFileSystem Overview 
+  # 
+  # 
+  # @wxrb_require USE_FILESYSTEM
+  class FSFile < Object
+  
+    # Constructor.
+    # 
+    # You probably won't use it. See the Note for details.
+    # 
+    # If you are not sure of the meaning of these params, see the description of the GetXXXX() functions.
+    # @param stream [IO]  The input stream that will be used to access data
+    # @param location [String]  The full location (aka filename) of the file
+    # @param mimetype [String]  MIME type of this file. It may be left empty, in which case the type will be determined from file's extension (location must not be empty in this case).
+    # @param anchor [String]  Anchor. See {Wx::FSFile#get_anchor} for details.
+    # @param modif [Time,Date,DateTime]  Modification date and time for this file.
+    # @return [Wx::FSFile]
+    def initialize(stream, location, mimetype, anchor, modif) end
+    
+    # Detaches the stream from the {Wx::FSFile} object.
+    # 
+    # That is, the stream obtained with {Wx::FSFile#get_stream} will continue its existence after the {Wx::FSFile} object is deleted.
+    # You will have to delete the stream yourself.
+    # @return [Wx::InputStream]
+    def detach_stream; end
+    
+    # Returns anchor (if present).
+    # 
+    # The term of <b>anchor</b> can be easily explained using few examples:
+    # index.htm\#anchor                      // 'anchor' is anchor
+    # index/{Wx::001}.htm                       // NO anchor here!
+    # archive/main.zip\#zip:index.htm\#global // 'global'
+    # archive/main.zip\#zip:index.htm        // NO anchor here!
+    # 
+    # Usually an anchor is presented only if the MIME type is 'text/html'. But it may have some meaning with other files; for example myanim.avi\#200 may refer to position in animation or reality.wrl\#MyView may refer to a predefined view in VRML.
+    # @return [Wx::String]
+    def get_anchor; end
+    alias_method :anchor, :get_anchor
+    
+    # Returns full location of the file, including path and protocol.
+    # 
+    # Examples: http://www.{Wx::widgets}.org
+    # http://www.ms.mff.cuni.cz/~vsla8348/{Wx::html}/archive.zip\#zip:info.txt
+    # file:/home/vasek/index.htm
+    # relative-file.htm
+    # @return [Wx::String]
+    def get_location; end
+    alias_method :location, :get_location
+    
+    # Returns the MIME type of the content of this file.
+    # 
+    # It is either extension-based (see {Wx::MimeTypesManager}) or extracted from HTTP protocol Content-Type header.
+    # @return [Wx::String]
+    def get_mime_type; end
+    alias_method :mime_type, :get_mime_type
+    
+    # Returns time when this file was modified.
+    # @return [Time,Date,DateTime]
+    def get_modification_time; end
+    alias_method :modification_time, :get_modification_time
+    
+    # Returns pointer to the stream.
+    # 
+    # You can use the returned stream to directly access data. You may suppose that the stream provide Seek and GetSize functionality (even in the case of the HTTP protocol which doesn't provide this by default. {Wx::HTML} uses local cache to work around this and to speed up the connection).
+    # @return [Wx::InputStream]
+    def get_stream; end
+    alias_method :stream, :get_stream
+    
+  end # FSFile
+  
+  # This class is the base class of most stream related classes in wxWidgets.
+  # 
+  # It must not be used directly.
+  # 
+  # Category:  {Wx::Streams}
+  # @see Wx::StreamBuffer 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_FILESYSTEM
+  class StreamBase < ::Object
+  
+    # Creates a dummy stream object.
+    # 
+    # It doesn't do anything.
+    # @return [Wx::StreamBase]
+    def initialize; end
+    
+    # This function returns the last error.
+    # @return [Wx::StreamError]
+    def get_last_error; end
+    alias_method :last_error, :get_last_error
+    
+    # Returns the length of the stream in bytes.
+    # 
+    # If the length cannot be determined (this is always the case for socket streams for example), returns {Wx::InvalidOffset}.
+    # @return [Integer]
+    def get_length; end
+    alias_method :length, :get_length
+    
+    # This function returns the size of the stream.
+    # 
+    # For example, for a file it is the size of the file.
+    # There are streams which do not have size by definition, such as socket streams. In that cases, {Wx::StreamBase#get_size} returns 0 so you should always test its return value.
+    # @return [Integer]
+    def get_size; end
+    alias_method :size, :get_size
+    
+    # Returns true if no error occurred on the stream.
+    # 
+    # 
+    # @see Wx::StreamBase#get_last_error 
+    # @return [Boolean]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+    # Returns true if the stream supports seeking to arbitrary offsets.
+    # @return [Boolean]
+    def is_seekable; end
+    alias_method :seekable?, :is_seekable
+    
+    # Resets the stream state.
+    # 
+    # By default, resets the stream to good state, i.e. clears any errors. Since wxWidgets 2.9.3 can be also used to explicitly set the state to the specified error (the error argument didn't exist in the previous versions).
+    # @see Wx::StreamBase#get_last_error 
+    # @param error [Wx::StreamError] 
+    # @return [void]
+    def reset(error=Wx::StreamError::STREAM_NO_ERROR) end
+    
+  end # StreamBase
+  
+  # {Wx::InputStream} is an abstract base class which may not be used directly.
+  # 
+  # It is the base class of all streams which provide a {Wx::InputStream#read} function, i.e. which can be used to read data from a source (e.g. a file, a socket, etc).
+  # If you want to create your own input stream, you'll need to derive from this class and implement the protected {Wx::InputStream#on_sys_read} function only.
+  # 
+  # Category:  {Wx::Streams}
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_FILESYSTEM
+  class InputStream < StreamBase
+  
+    # Creates a dummy input stream.
+    # @return [Wx::InputStream]
+    def initialize; end
+    
+    # Returns true if some data is available in the stream right now, so that calling {Wx::InputStream#read} wouldn't block.
+    # @return [Boolean]
+    def can_read; end
+    alias_method :can_read?, :can_read
+    
+    # Returns true after an attempt has been made to read past the end of the stream.
+    # @return [Boolean]
+    def eof; end
+    
+    # Returns the first character in the input queue and removes it, blocking until it appears if necessary.
+    # 
+    # On success returns a value between 0 - 255; on end of file returns {Wx::EOF}.
+    # @return [Integer]
+    def get_c; end
+    alias_method :c, :get_c
+    
+    # Returns the last number of bytes read by the last input operation.
+    # 
+    # Such operations include {Wx::InputStream#read}, {Wx::InputStream#get_c} and {Wx::InputStream#peek}.
+    # @return [Integer]
+    def last_read; end
+    
+    # Returns the first character in the input queue without removing it.
+    # 
+    # If {Wx::InputStream#peek} failed, e.g. because there is nothing more to read in the stream, {Wx::InputStream#last_read} will return 0 after calling it, otherwise it will return 1.
+    # @return [Integer]
+    def peek; end
+    
+    # Reads data from the input queue and stores it in the specified output stream.
+    # 
+    # The data is read until an error is raised by one of the two streams.
+    # This function returns a reference on the current object, so the user can test any states of the stream right away.
+    # @param stream_out [IO,Wx::OutputStream] 
+    # @return [Wx::InputStream]
+    def read(stream_out) end
+    
+    # Changes the stream current position.
+    # 
+    # This operation in general is possible only for seekable streams (see {Wx::StreamBase#is_seekable}); non-seekable streams support only seeking positive amounts in mode {Wx::SeekMode::FromCurrent} (this is implemented by reading data and simply discarding it).
+    # 
+    # The new stream position or {Wx::InvalidOffset} on error.
+    # @param pos [Integer]  Offset to seek to.
+    # @param mode [Wx::SeekMode]  One of {Wx::SeekMode::FromStart}, {Wx::SeekMode::FromEnd}, {Wx::SeekMode::FromCurrent}.
+    # @return [Integer]
+    def seek_i(pos, mode=Wx::SeekMode::FromStart) end
+    
+    # Returns the current stream position or {Wx::InvalidOffset} if it's not available (e.g.
+    # 
+    # socket streams do not have a size nor a current stream position).
+    # @return [Integer]
+    def tell_i; end
+    
+    # This function acts like the previous one except that it takes only one character: it is sometimes shorter to use than the generic function.
+    # @param c [Integer] 
+    # @return [Boolean]
+    def ungetch(c) end
+    
+  end # InputStream
+  
+  # {Wx::OutputStream} is an abstract base class which may not be used directly.
+  # 
+  # It is the base class of all streams which provide a {Wx::OutputStream#write} function, i.e. which can be used to output data (e.g. to a file, to a socket, etc).
+  # If you want to create your own output stream, you'll need to derive from this class and implement the protected {Wx::OutputStream#on_sys_write} function only.
+  # 
+  # Category:  {Wx::Streams}
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_FILESYSTEM
+  class OutputStream < StreamBase
+  
+    # Creates a dummy {Wx::OutputStream} object.
+    # @return [Wx::OutputStream]
+    def initialize; end
+    
+    # Closes the stream, returning false if an error occurs.
+    # 
+    # The stream is closed implicitly in the destructor if {Wx::OutputStream#close} is not called explicitly.
+    # If this stream wraps another stream or some other resource such as a file, then the underlying resource is closed too if it is owned by this stream, or left open otherwise.
+    # @return [Boolean]
+    def close; end
+    
+    # Returns the number of bytes written during the last {Wx::OutputStream#write}.
+    # 
+    # It may return 0 even if there is no error on the stream if it is only temporarily impossible to write to it.
+    # @return [Integer]
+    def last_write; end
+    
+    # Puts the specified character in the output queue and increments the stream position.
+    # @param c [Integer] 
+    # @return [void]
+    def put_c(c) end
+    
+    # Changes the stream current position.
+    # 
+    # The new stream position or {Wx::InvalidOffset} on error.
+    # @param pos [Integer]  Offset to seek to.
+    # @param mode [Wx::SeekMode]  One of {Wx::SeekMode::FromStart}, {Wx::SeekMode::FromEnd}, {Wx::SeekMode::FromCurrent}.
+    # @return [Integer]
+    def seek_o(pos, mode=Wx::SeekMode::FromStart) end
+    
+    # Returns the current stream position.
+    # @return [Integer]
+    def tell_o; end
+    
+  end # OutputStream
+  
+
+end