Class: Wx::ConfigWx

Inherits:
ConfigBase show all
Includes:
Wx::ConfigBase::Interface
Defined in:
lib/wx/doc/config.rb

Overview

This is an abstract class wrapping the default C++ Config class for the active platform (on Windows this would be wxRegConfig and wxFileConfig otherwise).

Unless Wx::ConfigBase.create or Wx::ConfigBase.set has been called this is what will be returned by Wx::ConfigBase.get.

Defined Under Namespace

Classes: Group

Constant Summary

Constants inherited from ConfigBase

Wx::ConfigBase::SEPARATOR

Instance Method Summary collapse

Methods included from Wx::ConfigBase::Interface

#[], #delete, #each_entry, #each_group, #get, #has_entry?, #has_group?, #number_of_entries, #number_of_groups, #parent, #path, #read, #rename, #root, #root?, #set, #to_h, #to_s, #write

Methods inherited from ConfigBase

create, get, set

Instance Method Details

#clear ⇒ Boolean

Deletes all configuration content and returns true if successful. Also deletes any persisted storage (files or registry entries).

Returns:

  • (Boolean) 


182
 
# File 'lib/wx/doc/config.rb', line 182

def clear; end

#is_expanding_env_vars ⇒ Boolean Also known as: expanding_env_vars?

Returns true if we are expanding environment variables in string values, false otherwise.

Returns:

  • (Boolean) 


191
 
# File 'lib/wx/doc/config.rb', line 191

def is_expanding_env_vars; end

#replace(hash) ⇒ self

Replaces the configuration content with the content of the provided Hash.

Parameters:

  • hash (Hash) —

    content to replace configuration

Returns:

  • (self) 


187
 
# File 'lib/wx/doc/config.rb', line 187

def replace(hash) end

#set_expand_env_vars(flag) ⇒ Object Also known as: expand_env_vars

Determine whether we wish to expand environment variables in string values.

Parameters:

  • flag (Boolean) —

    enables expanding environment variables if true, disables otherwise



196
 
# File 'lib/wx/doc/config.rb', line 196

def set_expand_env_vars(flag) end