File: HelpItem.h

package info (click to toggle)
qtop 2.3.4-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,976 kB
  • sloc: cpp: 40,477; makefile: 7
file content (84 lines) | stat: -rw-r--r-- 2,353 bytes parent folder | download | duplicates (3)
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
#ifndef HelpItem_h
#define HelpItem_h

/******************************************************************************
*
* Copyright (C) 2002 Hugo PEREIRA <mailto: hugo.pereira@free.fr>
*
* This 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 software 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.  If not, see <http://www.gnu.org/licenses/>.
*
*******************************************************************************/

#include "Counter.h"
#include "Debug.h"

#include <QList>

//* Help system namespace
namespace Base
{

    //* reference manual single entry
    class HelpItem final: private Counter<HelpItem>
    {

        public:

        //* constructor
        explicit HelpItem( const QString& label = QString(), const QString& text = QString() ):
            Counter( "HelpItem" ),
            label_( label ),
            text_( text )
        { Debug::Throw( "HelpItem::HelpItem.\n" ); }

        //* item label
        void setLabel( const QString& label )
        { label_ = label; }

        //* label
        const QString& label() const
        { return label_; }

        //* item text
        void setText( const QString& text )
        { text_ = text; }

        //* item text
        const QString& text() const
        { return text_; }

        //* shortcut to help item list
        using List = QList< HelpItem >;

        private:

        //* help label
        QString label_;

        //* help text
        QString text_;

    };

    //* equal-to operator
    inline bool operator == (const HelpItem& first, const HelpItem& second)
    { return first.label() == second.label() && first.text() == second.text(); }

    //* less than operator
    inline bool operator < (const HelpItem& first, const HelpItem& second)
    { return first.label() < second.label() || (first.label() == second.label() && first.text() < second.text() ); }

}

#endif