src/gtk/job_manager_view.h

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file src/job_manager_view.h
  21  *  @brief Class generating a GTK widget to show the progress of jobs.
  22  */
  23
  24 #include <string>
  25 #include <boost/shared_ptr.hpp>
  26 #include <gtkmm.h>
  27
  28 class Job;
  29
  30 /** @class JobManagerView
  31  *  @brief Class generating a GTK widget to show the progress of jobs.
  32  */
  33 class JobManagerView
  34 {
  35 public:
  36         JobManagerView ();
  37
  38         /** @return Our main widget, which contains everything else */
  39         Gtk::Widget& widget () {
  40                 return _scroller;
  41         }
  42
  43         void update ();
  44
  45 private:
  46         /** Scroller for all our contents */
  47         Gtk::ScrolledWindow _scroller;
  48         /** View for the jobs */
  49         Gtk::TreeView _view;
  50         /** Store for the jobs */
  51         Glib::RefPtr<Gtk::TreeStore> _store;
  52
  53         /** The TreeModelColumnRecord for the store */
  54         class StoreColumns : public Gtk::TreeModelColumnRecord
  55         {
  56         public:
  57                 StoreColumns ()
  58                 {
  59                         add (name);
  60                         add (job);
  61                         add (progress);
  62                         add (progress_unknown);
  63                         add (text);
  64                         add (informed_of_finish);
  65                 }
  66
  67                 /** Job name */
  68                 Gtk::TreeModelColumn<std::string> name;
  69                 /** Job */
  70                 Gtk::TreeModelColumn<boost::shared_ptr<Job> > job;
  71                 /** Progress */
  72                 Gtk::TreeModelColumn<float> progress;
  73                 /** An increasing integer number if the progress is unknown */
  74                 Gtk::TreeModelColumn<int> progress_unknown;
  75                 /** Text to write into the progress bar */
  76                 Gtk::TreeModelColumn<std::string> text;
  77                 /** true if the job has been informed of its finish */
  78                 Gtk::TreeModelColumn<bool> informed_of_finish;
  79         };
  80
  81         /** The columns for the store */
  82         StoreColumns _columns;
  83 };