paludis  Version 2.6.0
args_section.hh
1 /* vim: set sw=4 sts=4 et foldmethod=syntax : */
2 
3 /*
4  * Copyright (c) 2009, 2010, 2011 Ciaran McCreesh
5  *
6  * This file is part of the Paludis package manager. Paludis is free software;
7  * you can redistribute it and/or modify it under the terms of the GNU General
8  * Public License version 2, as published by the Free Software Foundation.
9  *
10  * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
11  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
13  * details.
14  *
15  * You should have received a copy of the GNU General Public License along with
16  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
17  * Place, Suite 330, Boston, MA 02111-1307 USA
18  */
19 
20 #ifndef PALUDIS_GUARD_PALUDIS_ARGS_ARGS_SECTION_HH
21 #define PALUDIS_GUARD_PALUDIS_ARGS_ARGS_SECTION_HH 1
22 
23 #include <paludis/util/pimp.hh>
25 #include <paludis/util/wrapped_forward_iterator.hh>
26 #include <string>
27 
28 namespace paludis
29 {
30  namespace args
31  {
32  class ArgsGroup;
33  class ArgsHandler;
34 
35  /**
36  * Holds a number of ArgsGroup instances.
37  *
38  * \since 0.40
39  * \ingroup g_args
40  */
42  {
43  private:
44  Pimp<ArgsSection> _imp;
45 
46  public:
47  ArgsSection(ArgsHandler * const, const std::string &);
48  ~ArgsSection();
49 
50  struct GroupsConstIteratorTag;
52  GroupsConstIterator begin() const PALUDIS_ATTRIBUTE((warn_unused_result));
53  GroupsConstIterator end() const PALUDIS_ATTRIBUTE((warn_unused_result));
54 
55  ArgsHandler * handler() const PALUDIS_ATTRIBUTE((warn_unused_result));
56  const std::string name() const PALUDIS_ATTRIBUTE((warn_unused_result));
57 
58  void add(ArgsGroup * const);
59  void remove(ArgsGroup * const);
60  };
61  }
62 
63  extern template class Pimp<args::ArgsSection>;
65 }
66 
67 #endif
Definition: pimp.hh:51
Definition: about_metadata-fwd.hh:23
Definition: args_group.hh:50
Definition: args_section.hh:41
Definition: wrapped_forward_iterator-fwd.hh:26
Definition: args_handler.hh:59
#define PALUDIS_ATTRIBUTE(x)
Definition: attributes.hh:53
#define PALUDIS_VISIBLE
Definition: attributes.hh:59