svn/view/mini_window.rb

# mini_window.rb: the module definition of Edmaru::MiniWindow
#
# 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 "window.rb"

module Edmaru

  #A special window that doesn't have modeline bar.
  module MiniWindow

    #Construct a window instance.
    #
    #=== Arguments
    #_view_ :: The parent view.
    #_config_ :: An instance of Edmaru::ConfigurationManager.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    #
    #=== Return
    #An initialized instance of Window.
    def initialize(view, config)
      @buffer = nil
      @view = view
      @config = config
      @cursor = Cursor.new(0, 0) # logical cursor
      @modeline = nil
      @prefix = ""

      init_ui
    end

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

    #Set the prefix for this window that cannot be deleted by user.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.    
    def prefix=(new_prefix)
      #Prefix cannot contain "\n".
      if new_prefix.empty?
        @prefix = ""
      else
        @prefix = new_prefix.split("\n")[0]
      end
    end

    #Terminate this view instance.
    #
    #=== Warning
    #This method *MUST* *NOT* be overrided in derived classes.
    def terminate
      terminate_ui
    end

    #Free system specific resources.
    #
    #=== Warning
    #This method *SHOULD* be overrided in derived classes.
    def terminate_ui
    end
  end
end