summaryrefslogtreecommitdiff
path: root/src/cmdline/cmdline_progress.h
blob: b194da0637ad2e8ed1ee970ee762a7dcf9f70e93 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
// cmdline_progress.h                  -*-c++-*-
//
//  Copyright 2004, 2010 Daniel Burrows
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 2 of the
// License, or (at your option) any later version.
//
// 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; see the file COPYING.  If not, write to
// the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
// Boston, MA 02111-1307, USA.

#ifndef CMDLINE_PROGRESS_H
#define CMDLINE_PROGRESS_H

/** \file cmdline_progress.h
 */

// System includes:

#include <boost/shared_ptr.hpp>

class download_signal_log;

namespace aptitude
{
  namespace controllers
  {
    class acquire_download_progress;
  }

  namespace cmdline
  {
    class terminal_input;
    class terminal_locale;
    class terminal_metrics;
    class terminal_output;

    /** \brief Create the objects required to display the progress of a
     *  download on the given terminal.
     *
     *  \note this is just a convenience routine that ties together
     *  some other modules of code.
     *
     *  \return a pair containing the download signal log to use and a
     *  strong reference to the download progress complex of objects.
     */
    std::pair<download_signal_log *, boost::shared_ptr<controllers::acquire_download_progress> >
    create_cmdline_download_progress(const boost::shared_ptr<terminal_input> &term_input,
                                     const boost::shared_ptr<terminal_locale> &term_locale,
                                     const boost::shared_ptr<terminal_metrics> &term_metrics,
                                     const boost::shared_ptr<terminal_output> &term_output);
  }
}

#endif // CMDLINE_PROGRESS_H