Class: Wx::FileSystem

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/file_system.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

This class provides an interface for opening files on different file systems.

It can handle absolute and/or local filenames. It uses a system of handlers (see FileSystemHandler) to provide access to user-defined virtual file systems.

Category: Virtual File System

See Also:

Requires:

  • USE_FILESYSTEM

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::FileSystem

Constructor.

The initial current path of this object will be empty (i.e. get_path == EmptyString) which means that e.g. open_file or find_first functions will use current working directory as current path (see also GetCwd).



29
 
# File 'lib/wx/doc/gen/file_system.rb', line 29

def initialize; end

Class Method Details

.file_name_to_url(filename) ⇒ String

Converts a Wx::FileName into an URL.

Parameters:

  • filename (String)

Returns:

  • (String)

See Also:



43
 
# File 'lib/wx/doc/gen/file_system.rb', line 43

def self.file_name_to_url(filename) end

.has_handler_for_path(location) ⇒ Boolean

This static function returns true if there is a registered handler which can open the given location.

Parameters:

  • location (String)

Returns:

  • (Boolean) 


48
 
# File 'lib/wx/doc/gen/file_system.rb', line 48

def self.has_handler_for_path(location) end

.remove_handler(handler) ⇒ Wx::FileSystemHandler

Remove a filesystem handler from the list of handlers.

Parameters:

Returns:



34
 
# File 'lib/wx/doc/gen/file_system.rb', line 34

def self.remove_handler(handler) end

.url_to_file_name(url) ⇒ String

Converts URL into a well-formed filename.

The URL must use the file protocol.

Parameters:

  • url (String)

Returns:

  • (String) 


55
 
# File 'lib/wx/doc/gen/file_system.rb', line 55

def self.url_to_file_name(url) end