Module: Hirb

### Home Classes Methods

### In Files

- lib/hirb/console.rb
- lib/hirb/dynamic_view.rb
- lib/hirb/formatter.rb
- lib/hirb/helpers/table.rb
- lib/hirb/helpers.rb
- lib/hirb/import_object.rb
- lib/hirb/menu.rb
- lib/hirb/pager.rb
- lib/hirb/string.rb
- lib/hirb/util.rb
- lib/hirb/version.rb
- lib/hirb/view.rb
- lib/hirb/views.rb
- lib/hirb.rb

### Namespace

- MODULE Hirb::Console
- MODULE Hirb::DynamicView
- MODULE Hirb::Helpers
- MODULE Hirb::ObjectMethods
- MODULE Hirb::String
- MODULE Hirb::Util
- MODULE Hirb::View
- MODULE Hirb::Views
- CLASS Hirb::Formatter
- CLASS Hirb::Menu
- CLASS Hirb::Pager

### Methods

- ::add_dynamic_view
- ::add_view
- ::disable
- ::enable

### Files

- LICENSE.txt
- README.rdoc

### Class/Module Index

Quicksearch

- Hirb
- Hirb::Console
- Hirb::DynamicView
- Hirb::Formatter
- Hirb::Helpers
- Hirb::Helpers::AutoTable
- Hirb::Helpers::ObjectTable
- Hirb::Helpers::ParentChildTree
- Hirb::Helpers::Table
- Hirb::Helpers::Table::Filters
- Hirb::Helpers::Table::Resizer
- Hirb::Helpers::Table::TooManyFieldsForWidthError
- Hirb::Helpers::Tree
- Hirb::Helpers::Tree::Node
- Hirb::Helpers::Tree::Node::MissingLevelError
- Hirb::Helpers::Tree::Node::MissingValueError
- Hirb::Helpers::Tree::ParentlessNodeError
- Hirb::Helpers::VerticalTable
- Hirb::Menu
- Hirb::Menu::Error
- Hirb::ObjectMethods
- Hirb::Pager
- Hirb::String
- Hirb::Util
- Hirb::View
- Hirb::Views

No matching classes.

# Hirb

Most of Hirb’s functionality is in Hirb::View. For a tutorial on configuring and creating views see Hirb::View. For a tutorial on dynamic views see Hirb::DynamicView.

## Config Files

Hirb can have multiple config files defined by config_files(). These config files have the following top level keys:

:output

  This hash is used by the formatter object. See Hirb::Formatter.config for its format.

:width

  Width of the terminal/console. Defaults to Hirb::View::DEFAULT_WIDTH or possibly autodetected when Hirb is enabled.

:height

  Height of the terminal/console. Defaults to Hirb::View::DEFAULT_HEIGHT or possibly autodetected when Hirb is enabled.

:formatter

  Boolean which determines if the formatter is enabled. Defaults to true.

:pager

  Boolean which determines if the pager is enabled. Defaults to true.

:pager_command

  Command to be used for paging. Command can have options after it i.e. ‘less -r’. Defaults to common pagers i.e. less and more if detected.

### Constants

VERSION

### Attributes

config[RW]
config_files[RW]

### Public Class Methods

add_dynamic_view(view, options, &block) click to toggle source

Adds views. See Hirb::DynamicView.add for details.

    # File lib/hirb.rb, line 49
    def add_dynamic_view(view, options, &block)
      DynamicView.add(view, options, &block)
    end

add_view(view, options, &block) click to toggle source

Adds views. See Hirb::View.add for details.

    # File lib/hirb.rb, line 44
    def add_view(view, options, &block)
      View.add(view, options, &block)
    end

disable() click to toggle source

Disables view functionality. See Hirb::View.disable for details.

    # File lib/hirb.rb, line 39
    def disable
      View.disable
    end

enable(options={}, &block) click to toggle source

Enables view functionality. See Hirb::View.enable for details.

    # File lib/hirb.rb, line 34
    def enable(options={}, &block)
      View.enable(options, &block)
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.