svn/view/modeline.rb

# modeline.rb: the module definition of Edmaru::ModeLine
#
# Copyright (C) 2007 Takashi Nakamoto
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 USA.
#

require "modeline_element.rb"

module Edmaru
  
  module ModeLine

    #Construct the modeline instance.
    #
    #=== Arguments
    #_window_ :: The parent window.
    #_x_ :: The left edge position in the window's parent view.
    #_y_ :: The right edge position in the window's parent view.
    #_col_ :: The column size allocated for this modeline.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    #
    #=== Return
    #An initialized instance of ModeLine.
    def initialize(window)
      @window = window
      @elements = Hash.new
      @elements_order = Array.new

      init_ui
    end

    #The system specific initialization for ModeLine.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived classes.
    def init_ui
    end

    #Add the specified _element_, an instance of ModeLineElement, to
    #this ModeLine.
    #
    #=== Argument
    #_element_ :: an instance of ModeLineElement to be added.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    #
    #=== Return
    #_true_ if the addition is succeeded.
    #_false_ if the _element_'s name has already reserved.
    def add_element(element)
      if @elements.include?(element.name)
        return false
      end

      @elements[element.name] = element
      @elements_order.push(element.name)
    end

    #Show the specified element.
    #
    #=== Argument
    #_name_ :: the name of the element.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    def show_element(name)
      if !@elements.include?(name) || @elements[name].visible?
        return
      end

      @elements[name].visible = true
      refresh
    end

    #Hide the specified element.
    #
    #=== Argument
    #_name_ :: the name of the element.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    def hide_element(name)
      if !@elements.include?(name) || !@elements[name].visible?
        return
      end

      @elements[name].visible = false
      refresh
    end

    #Set the text of the specified element.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    #
    #=== Argument
    #_name_ :: the name of this element
    #_text_ :: a new text to be set as the text of the specified element.
    def set_element_text(name, text)
      if !@elements.include?(name) || @elements[name].text == text
        return
      end

      @elements[name].text = text
      refresh
    end


    #Get the specified element.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    #
    #=== Argument
    #_name_ :: the name of the element.
    #
    #=== Return
    #An instance of ModeLineElement whose name is the specified name
    #or _nil_ if the specified name is not registered.
    def get_element(name)
      if !@elements.include?(name)
        return nil
      end

      @elements[name]
    end

    #Redraws this modeline.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived classes.
    def refresh
    end

    #Terminate this modeline instance.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived classes.
    def terminate
    end
  end
end