Class: Fox::FXRegistry

Inherits:
FXSettings show all
Defined in:
rdoc-sources/FXRegistry.rb

Overview

The registry maintains a database of persistent settings for an application. The settings database is organized in two groups of three layers each. The system-wide settings group contains settings information pertaining to all users on a system. The per-user settings group contains settings affecting that user only. Each settings group contains a desktop layer, which comprises the settings which affect all FOX programs, a vendor layer which holds settings that affect all applications from that vendor (e.g. a application-suite), and an application layer which holds settings only for a single application. The vendor-key and application-key determine which files these layers come from, while the “Desktop” key is used for all FOX applications. Settings in the system-wide group are overwritten by the per-user group, and settings from the “Desktop” layer are overwritten by the vendor-layer; vendor-layer settings are overwritten by the application-layer settings. Only the per-user, per-application settings ever gets written; the layers in the system-group only get written during installation and configuration of the application. The registry is read when FXApp::init() is called, and written back to the system when FXApp::exit() is called.

Instance Attribute Summary collapse

Attributes inherited from FXDict

#first, #last, #length

Instance Method Summary collapse

Methods inherited from FXSettings

#data, #deleteEntry, #deleteSection, #each_section, #existingEntry?, #existingSection?, #find, #modified=, #modified?, #parseFile, #readBoolEntry, #readColorEntry, #readIntEntry, #readRealEntry, #readStringEntry, #readUnsignedEntry, #unparseFile, #writeBoolEntry, #writeColorEntry, #writeIntEntry, #writeRealEntry, #writeStringEntry, #writeUnsignedEntry

Methods inherited from FXDict

#clear, #each_key, #empty?, #has_key?, #key, #keys, #marked?, #next, #prev

Methods inherited from FXObject

#bind, #handle, #load, #save, subclasses

Constructor Details

#initialize(appKey = "", vendorKey = "") ⇒ FXRegistry

Construct registry object; appKey and vendorKey must be string constants. Regular applications SHOULD set a vendor key!



38
 
# File 'rdoc-sources/FXRegistry.rb', line 38

def initialize(appKey="", vendorKey="") ; end

Instance Attribute Details

#appKey ⇒ Object (readonly)

Application key [String]



26
27
28
 
# File 'rdoc-sources/FXRegistry.rb', line 26

def appKey
  @appKey
end

#asciiMode=(value) ⇒ Object (writeonly)

Use file-based registry instead of Windows Registry [Boolean]



32
33
34
 
# File 'rdoc-sources/FXRegistry.rb', line 32

def asciiMode=(value)
  @asciiMode = value
end

#vendorKey ⇒ Object (readonly)

Vendor key [String]



29
30
31
 
# File 'rdoc-sources/FXRegistry.rb', line 29

def vendorKey
  @vendorKey
end

Instance Method Details

#asciiMode? ⇒ Boolean

Return true if we’re using a file-based registry mechanism instead of the Windows Registry (only relevant on Windows systems).

Returns:

  • (Boolean) 


54
 
# File 'rdoc-sources/FXRegistry.rb', line 54

def asciiMode?; end

#read ⇒ Object

Read registry.



43
 
# File 'rdoc-sources/FXRegistry.rb', line 43

def read; end

#write ⇒ Object

Write registry.



48
 
# File 'rdoc-sources/FXRegistry.rb', line 48

def write; end