zerenity 1.3

data/lib/zerenity/info.rb

@@ -0,0 +1,18 @@
+require 'zerenity/messagedialog'
+
+module Zerenity
+  # Displays an informational popup dialog on the screen.
+  #
+  # ====Examle Usage
+  #  Zerenity::Info(:text=>"Processing has completed.")
+  def Zerenity::Info(options={})
+    Info.run(options)
+  end
+
+  class Info < MessageDialog # :nodoc: 
+      def self.check(options)
+        super(options)
+        options[:type] = Gtk::MessageDialog::INFO
+      end
+  end
+end

data/lib/zerenity/list.rb

@@ -0,0 +1,110 @@
+require('zerenity/base')
+
+module Zerenity
+  # Displays a list dialog on the screen. Items in the list
+  # can be selected. Returns the rows which were selected 
+  # or nil if Cancel is clicked.
+  #
+  # ====Options
+  # [:columns] The names which will be displayed at the top og
+  #             each column. This option is mandatory.
+  # [:data] The data for the list,  with each row
+  #         being another array.
+  # [:radiolist] If this is set true the first column of the 
+  #              list will be rendered as a radiobutton. The first element
+  #              of every data array should either be a true or false.
+  # [:checklist] If this is set true the first column of the 
+  #              list will be rendered as a checkbox. The first element
+  #              of every data array should either be a true or false.
+  #              When this is set mutiple rows can be selected and an 
+  #              array of selected rows are returned.
+  # *Note* :radiolist and :checklist are mutually exclusive. If 
+  # both are set true an exception is thrown. An exception
+  # is also thrown if the data rows are not equal length or 
+  # they differ in length with the number of columns.
+  #
+  # ====Example Usage
+  #  choice = Zerenity::List(:columns=>["Food","Energy"],:data=>[["Chips","200KJ"],["Chocolate","300KJ"]])
+  def self.List(options={})
+    List.run(options)
+  end
+
+  class List < Base # :nodoc:
+    def self.check(options)
+      super(options)
+      raise(ArgumentError.new("No column data was given")) unless options[:data]      
+      raise(ArgumentError.new("No column headers were given")) unless  options[:columns]
+      raise(ArgumentError.new("Column headers and column data differ in length")) unless  options[:columns].length.eql?(options[:data][0].length)
+      raise(ArgumentError.new("Column data lengths are not equal")) unless  options[:data].map{|element|element.length}.uniq.length.eql?(1)
+      raise(ArgumentError.new("Radiolist and checklist options can not both be set")) if (options[:radiolist] && options[:checklist]) 
+    end
+
+    def self.build(dialog,options)
+      super(dialog,options)
+      columnTypes = Array.new(options[:columns].length){String}
+      (options[:radiolist] || options[:checklist]) ? columnTypes[0] = TrueClass : nil
+      listStore = Gtk::ListStore.new(*columnTypes)
+      options[:data].each do |datarow|
+        row = listStore.append
+        datarow.each_with_index do |value,index|
+          row[index] = value
+        end
+      end
+      treeView = Gtk::TreeView.new(listStore)
+      treeView.selection.mode = (options[:checklist] ? Gtk::SELECTION_MULTIPLE : Gtk::SELECTION_SINGLE)
+      toggleProc = (if (treeView.selection.mode.eql?(Gtk::SELECTION_SINGLE))
+                    lambda do |cell,path|
+                      selectedRow = treeView.model.get_iter(path)
+                      if !selectedRow[0]
+                        selectedRow[0] = true 
+                        currentRow = treeView.model.iter_first
+                        begin
+                          currentRow[0] = false unless selectedRow == currentRow
+                        end while (currentRow.next!)
+                      end
+                    end
+    else
+      lambda do |cell,path|
+        selectedRow = treeView.model.get_iter(path)
+        selectedRow[0] = !selectedRow[0]
+      end
+    end)
+    options[:columns].each_with_index do |columnName,index|
+      renderer,column =  columnTypes[index].eql?(TrueClass) ? [Gtk::CellRendererToggle.new,:active] : [Gtk::CellRendererText.new,:text]
+      if index.eql?(0)
+        renderer.signal_connect('toggled',&toggleProc) if renderer.class.eql?(Gtk::CellRendererToggle)
+        renderer.set_radio(true) if options[:radiolist]
+      end
+      treeView.append_column(Gtk::TreeViewColumn.new(columnName,renderer,column=>index))
+    end
+    dialog.vbox.add(treeView)
+  end
+
+  def self.retrieve_selection(dialog,options)
+    super(dialog,options)
+    treeView = dialog.vbox.children[0]
+    results = []
+    if (options[:checklist])
+      treeView.model.each do |model,path,selectedRow|
+        if selectedRow[0]
+          resultRow = []
+          (model.n_columns-1).times {|index| resultRow << selectedRow[index+1]}
+          results << resultRow
+        end
+      end
+      return nil if results.size.zero?
+    elsif(options[:radiolist])
+      treeView.model.each do |model,path,selectedRow|
+        if selectedRow[0]
+          (model.n_columns-1).times{|index| results << selectedRow[index+1]}
+          break
+        end
+      end
+    else
+      selectedRow = treeView.selection.selected
+      treeView.model.n_columns.times{|index| results << selectedRow[index]}
+    end
+    return results
+  end
+end
+end

data/lib/zerenity/messagedialog.rb

@@ -0,0 +1,34 @@
+require 'zerenity/base'
+
+module Zerenity
+  class MessageDialog < Base # :nodoc: 
+    def self.build(dialog,options)
+      options[:ok_button] = dialog.add_button(Gtk::Stock::OK,Gtk::Dialog::RESPONSE_OK)
+      dialog.set_default_response(Gtk::Dialog::RESPONSE_OK)
+    end
+    
+     def self.run(options={})
+      Gtk.init
+      self.check(options)
+      dialog = Gtk::MessageDialog.new(nil,Gtk::Dialog::MODAL,options[:type],Gtk::MessageDialog::BUTTONS_NONE,options[:text])
+      self.build(dialog,options)
+      dialog.set_title(options[:title]) if options[:title]
+      result = nil
+      if options[:cancel_button]
+        options[:cancel_button].signal_connect(CLICKED) do
+          dialog.destroy
+          Gtk.main_quit
+        end
+      end
+
+      options[:ok_button].signal_connect(CLICKED) do
+        result = true
+        dialog.destroy
+        Gtk.main_quit
+      end
+      dialog.show_all
+      Gtk.main
+      return result
+    end
+  end
+end

data/lib/zerenity/progress.rb

@@ -0,0 +1,136 @@
+require('zerenity/base')
+module Zerenity
+  # Displays a progress bar which can be updated via a processing
+  # block which is passed a ProgressProxy object.
+  #
+  # ====Options
+  # [:autoClose] The dialog will automatically close once the
+  #              progressing block is complete.
+  # [:cancellable] If set to true the Cancel button is enabled
+  #                and the ProgressProxy#cancelled? will be set to true if it 
+  #                is clicked. It is the responsibility of the processing block
+  #                to monitor this attribute and perfom the necessary actions
+  #                when it is ckicked.
+  #
+  # ====Example Usage
+  #  Zerenity::Progress(:text=>"Processing...",:cancellable=>true,:title=>"Processing Files") do |progress|
+  #    files.each_with_index do |file,index|
+  #       progress.cancelled ? break : nil
+  #       process_file(file)
+  #       progress.update(index/files.size,"#{((index/files.size)*100).round}% Complete")
+  #    end  
+  #    if progress.cancelled?
+  #      progress.text = "Cleaning up..."
+  #      cleanup_files(files)
+  #    end
+  #  end
+  def self.Progress(options={},&block)
+    Progress.run(options,&block)
+  end
+
+  class Progress < Base # :nodoc:
+    
+    def self.check(options)
+      super(options)
+      options[:autoClose] ||= false
+      options[:cancellable] ||= false
+    end
+    
+    def self.build(dialog,options,progressProxy)
+      super(dialog,options)
+      label = Gtk::Label.new(options[:text])
+      progressBar = Gtk::ProgressBar.new
+      progressProxy.progressBar = progressBar
+      progressBar.pulse_step = 0.02
+      !options[:cancellable] ? options[:cancel_button].sensitive = false : nil
+      options[:ok_button].sensitive = false
+      dialog.vbox.add(label)
+      dialog.vbox.add(progressBar)
+    end
+
+    def self.run(options={},&block)
+      self.check(options)
+      Gtk.init
+      dialog = Gtk::Dialog.new(options[:title])
+      result = nil
+      progressProxy = Zerenity::ProgressProxy.new
+      self.build(dialog,options,progressProxy)
+      options[:cancel_button].signal_connect(CLICKED) do
+        progressProxy.cancel!
+      end
+      options[:ok_button].signal_connect(CLICKED) do
+        result = true
+        dialog.destroy
+        Gtk.main_quit
+      end
+      dialog.show_all
+      gtkThread = Thread.new do 
+        Gtk.main
+      end
+      block.call(progressProxy)
+      if options[:autoClose]
+        dialog.destroy
+        Gtk.main_quit
+        return true 
+      end
+      options[:ok_button].sensitive = true
+      options[:cancel_button].sensitive = false 
+      gtkThread.join
+      return result
+    end
+  end
+
+  # ProgressProxy allows you to update the progress of the 
+  # Zerenity::Progress dialog. It also can alert the processing
+  # block whether or not the Cancel button has been clicked.
+  class ProgressProxy
+    # An attribute indicating whether the Cancel button has been clicked.
+    attr_reader :cancelled
+    
+    def initialize() # :nodoc:
+      @progressBar = nil 
+      @cancelled = false
+    end
+    
+    def progressBar=(progressBar) # :nodoc:
+      @progressBar = progressBar
+    end
+    
+    # Updates the progress bar.
+    #
+    # ====Parameters
+    # [percentage] The percentage completed. Values range from 0 to 1.
+    # [text] Optional text that will be displayed in the progress area.
+    def update(percentage,text=nil)
+      @progressBar.text = text.to_s if text
+      @progressBar.fraction = percentage.to_f
+    end
+
+    # When called will put the progress bar into 'pulse' mode. A 
+    # small bar will move forwards and backwards across the progress
+    # area. 
+    def pulse(text=nil)
+      @progressBar.text = text.to_s if text
+      @progressBar.pulse
+    end
+
+    # Sets the text in the progress area.
+    def text=(text)
+      @progressBar.text = text.to_s
+    end
+
+    # Sets the percentage complete of the  progress bar. Must be in the range 0-1.
+    def percentage=(percentage)
+      @progressBar.fraction = percentage.to_f
+    end
+
+    # Alias for cancelled.
+    def cancelled?
+      @cancelled
+    end
+
+    def cancel! #:nodoc:
+      @cancelled = true 
+    end
+  end
+end

data/lib/zerenity/progress.rb~

@@ -0,0 +1,136 @@
+require('zerenity/base')
+module Zerenity
+  # Displays a progress bar which can be updated via a processing
+  # block which is passed a ProgressProxy object.
+  #
+  # ====Options
+  # [:autoClose] The dialog will automatically close once the
+  #              progressing block is complete.
+  # [:cancellable] If set to true the Cancel button is enabled
+  #                and the ProgressProxy#cancelled? will be set to true if it 
+  #                is clicked. It is the responsibility of the processing block
+  #                to monitor this attribute and perfom the necessary actions
+  #                when it is ckicked.
+  #
+  # ====Example Usage
+  #  Zerenity::Progress(:text=>"Processing...",:cancellable=>true,:title=>"Processing Files") do |progress|
+  #    files.each_with_index do |file,index|
+  #       progress.cancelled ? break : nil
+  #       process_file(file)
+  #       progress.update(index/files.size,"#{((index/files.size)*100).round}% Complete")
+  #    end  
+  #    if progress.cancelled?
+  #      progress.text = "Cleaning up..."
+  #      cleanup_files(files)
+  #    end
+  #  end
+  def self.Progress(options={},&block)
+    Progress.run(options,&block)
+  end
+
+  class Progress < Base # :nodoc:
+    
+    def self.check(options)
+      super(options)
+      options[:autoClose] ||= false
+      options[:cancellable] ||= false
+    end
+    
+    def self.build(dialog,options,progressProxy)
+      super(dialog,options)
+      label = Gtk::Label.new(options[:text])
+      progressBar = Gtk::ProgressBar.new
+      progressProxy.progressBar = progressBar
+      progressBar.pulse_step = 0.02
+      !options[:cancellable] ? options[:cancel_button].sensitive = false : nil
+      options[:ok_button].sensitive = false
+      dialog.vbox.add(label)
+      dialog.vbox.add(progressBar)
+    end
+
+    def self.run(options={},&block)
+      self.check(options)
+      Gtk.init
+      dialog = Gtk::Dialog.new(options[:title])
+      result = nil
+      progressProxy = Zerenity::ProgressProxy.new
+      self.build(dialog,options,progressProxy)
+      options[:cancel_button].signal_connect(CLICKED) do
+        progressProxy.cancel!
+      end
+      options[:ok_button].signal_connect(CLICKED) do
+        result = true
+        dialog.destroy
+        Gtk.main_quit
+      end
+      dialog.show_all
+      gtkThread = Thread.new do 
+        Gtk.main
+      end
+      block.call(progressProxy)
+      if options[:autoClose]
+        dialog.destroy
+        Gtk.main_quit
+        return true 
+      end
+      options[:ok_button].sensitive = true
+      options[:cancel_button].sensitive = false 
+      gtkThread.join
+      return result
+    end
+  end
+
+  # ProgressProxy allows you to update the progress of the 
+  # Zerenity::Progress dialog. It also can alert the processing
+  # block whether or not the Cancel button has been clicked.
+  class ProgressProxy
+    # An attribute indicating whether the Cancel button has been clicked.
+    attr_reader :cancelled
+    
+    def initialize() # :nodoc:
+      @progressBar = nil 
+      @cancelled = false
+    end
+    
+    def progressBar=(progressBar) # :nodoc:
+      @progressBar = progressBar
+    end
+    
+    # Updates the progress bar.
+    #
+    # ====Parameters
+    # [percentage] The percentage completed. Values range from 0 to 1.
+    # [text] Optional text that will be displayed in the progress area.
+    def update(percentage,text=nil)
+      text ? @progressBar.text = text.to_s : nil
+      @progressBar.fraction = percentage.to_f
+    end
+
+    # When called will put the progress bar into 'pulse' mode. A 
+    # small bar will move forwards and backwards across the progress
+    # area. 
+    def pulse(text=nil)
+      text ? @progressBar.text = text.to_s : nil
+      @progressBar.pulse
+    end
+
+    # Sets the text in the progress area.
+    def text=(text)
+      @progressBar.text = text.to_s
+    end
+
+    # Sets the percentage complete of the  progress bar. Must be in the range 0-1.
+    def percentage=(percentage)
+      @progressBar.fraction = percentage.to_f
+    end
+
+    # Alias for cancelled.
+    def cancelled?
+      @cancelled
+    end
+
+    def cancel! #:nodoc:
+      @cancelled = true 
+    end
+  end
+end

data/lib/zerenity/question.rb

@@ -0,0 +1,26 @@
+require('zerenity/messagedialog')
+
+module Zerenity
+  # Displays a question dialog. Returns true if OK is clicked, false if 
+  # Cancel is clicked.
+  #
+  # ====Example Useage
+  #  if Zerenity::Question(:text=>"Continue processing?")
+  #    post_process_files()
+  #  end
+  def self.Question(options={})
+    Question.run(options)
+  end
+
+  class Question < MessageDialog # :nodoc:
+    def self.check(options)
+      super(options)
+      options[:type] = Gtk::MessageDialog::QUESTION
+    end
+
+    def self.build(dialog,options)
+      super(dialog,options)
+      options[:cancel_button] = dialog.add_button(Gtk::Stock::CANCEL,Gtk::Dialog::RESPONSE_CANCEL)
+    end
+  end
+end