added comments, several fixes
[platform/upstream/libzypp.git] / zypp / Message.h
1 /*---------------------------------------------------------------------\
2 |                          ____ _   __ __ ___                          |
3 |                         |__  / \ / / . \ . \                         |
4 |                           / / \ V /|  _/  _/                         |
5 |                          / /__ | | | | | |                           |
6 |                         /_____||_| |_| |_|                           |
7 |                                                                      |
8 \---------------------------------------------------------------------*/
9 /** \file zypp/Message.h
10  *
11 */
12 #ifndef ZYPP_MESSAGE_H
13 #define ZYPP_MESSAGE_H
14
15 #include <iosfwd>
16
17 #include "zypp/Resolvable.h"
18
19 ///////////////////////////////////////////////////////////////////
20 namespace zypp
21 { /////////////////////////////////////////////////////////////////
22
23   ///////////////////////////////////////////////////////////////////
24   namespace detail
25   { /////////////////////////////////////////////////////////////////
26     DEFINE_PTR_TYPE(MessageImpl)
27     /////////////////////////////////////////////////////////////////
28   } // namespace detail
29   ///////////////////////////////////////////////////////////////////
30   DEFINE_PTR_TYPE(Message)
31
32   ///////////////////////////////////////////////////////////////////
33   //
34   //    CLASS NAME : Message
35   //
36   /** Class representing the message to be shown during update */
37   class Message : public Resolvable
38   {
39   public:
40     /** Default ctor */
41     Message( detail::MessageImplPtr impl_r );
42     /** Dtor */
43     ~Message();
44   public:
45     /** Get the text of the message */
46     std::string text ();
47     /** Get the type of the message (YesNo / OK) */
48     std::string type ();
49   private:
50     /** Pointer to implementation */
51     detail::MessageImplPtr _pimpl;
52   };
53
54   /////////////////////////////////////////////////////////////////
55 } // namespace zypp
56 ///////////////////////////////////////////////////////////////////
57 #endif // ZYPP_MESSAGE_H