class Dmenu

@example A simple menu

menu = Dmenu.new
menu.items = ["foo", "bar", Dmenu::Item.new("baz", 123)]

menu.run # this will return a Dmenu::Item, according to what the user selected.

Constants

VERSION

Attributes

background[RW]

@return [String] The background color of normal items.

case_insensitive[RW]

@return [Boolean] If true, menu entries will be matched case insensitively.

font[RW]

@return [String] Which font to use.

foreground[RW]

@return [String] The foreground color of normal items.

items[RW]

@return [Array<#to_s, Item>] Items to display in the menu. Items

that are not an instance of the {Item} class will transparently
be converted into one.

lines[RW]

@return [Number] Number of lines to display. If >1, dmenu will go into vertical mode.

position[RW]

@return [Symbol<:top, :bottom>] Where to display the menu on screen.

prompt[RW]

@return [String] Defines a prompt to be displayed before the input area.

selected_background[RW]

@return [String] The background color of selected items.

selected_foreground[RW]

@return [String] The foreground color of selected items.

Public Class Methods

new() click to toggle source

# File lib/dmenu.rb, line 33
def initialize
  @items               = []
  @position            = :top
  @case_insensitive    = false
  @lines               = 1
  @font                = nil
  @background          = nil
  @foreground          = nil
  @selected_background = nil
  @selected_foreground = nil
  @prompt              = nil
end

Public Instance Methods

run() click to toggle source

Launches dmenu, displays the generated menu and waits for the user to make a choice.

@return [Item, nil] Returns the selected item or nil, if the user

didn't make any selection (i.e. pressed ESC)

# File lib/dmenu.rb, line 51
def run
  pipe = IO.popen(command, "w+")

  items = @items.map {|item|
    if item.is_a?(Item)
      item
    else
      Item.new(item, item)
    end
  }

  items.each do |item|
    pipe.puts item.key.to_s
  end

  pipe.close_write
  value = pipe.read
  pipe.close

  if $?.exitstatus > 0
    return nil
  end

  value.chomp!
  selection = items.find {|item|
    item.key.to_s == value
  }

  return selection
end

Private Instance Methods

command() click to toggle source

# File lib/dmenu.rb, line 84
def command
  args = ["dmenu"]

  if @position == :bottom
    args << "-b"
  end

  if @case_insensitive
    args << "-i"
  end

  if @lines > 1
    args << "-l"
    args << lines.to_s
  end

  h = {
    "fn" => @font,
    "nb" => @background,
    "nf" => @foreground,
    "sb" => @selected_background,
    "sf" => @selected_foreground,
    "p"  => @prompt,
  }

  h.each do |flag, value|
    if value
      args << "-#{flag}"
      args << value
    end
  end

  return args
end