Module: Ruber::State

Defined in:
plugins/state/state.rb

Overview

Plugin which allows Ruber to store and restore back its state.

In this context, the term state means the open project and documents, the tabs in the main window, the editors in each tab, the position of the cursor in the editors and the active editor. All this data is stored in the configuration file and in the project or document project files. Using the API provided by this plugin, it is possible to restore a single document, project or the whole application to the state it was when it was last closed.

Documents which haven’t been saved to a file are only partially restored: an empty document is created for them (different views associated with the same document will correctly be associated with the same empty document after restoration). Unsaved changes in documents not associated with files won’t be restored.

In addition to providing an API for saving and restoring state, this plugin also restores the full Ruber state when restoring a session and (according to the user preferences) when the application starts up.

API for feature state

Plugin object API

See API for Plugin

Defined Under Namespace

Modules: EnvironmentState Classes: ConfigWidget, DocumentExtension, Plugin, ProjectExtension