File: label.hpp

package info (click to toggle)
sight 25.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 42,184 kB
  • sloc: cpp: 289,476; xml: 17,257; ansic: 9,878; python: 1,379; sh: 144; makefile: 33
file content (88 lines) | stat: -rw-r--r-- 3,076 bytes parent folder | download
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
85
86
87
88
/************************************************************************
 *
 * Copyright (C) 2023-2025 IRCAD France
 *
 * This file is part of Sight.
 *
 * Sight is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Sight 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Sight. If not, see <https://www.gnu.org/licenses/>.
 *
 ***********************************************************************/

#pragma once

#include "select.hpp"

#include <ui/test/tester.hpp>

namespace sight::ui::test::helper
{

class label
{
public:

    /**
     * Check whether the tooltip of a label exactly matches the expected result.
     * @param _tester The current tester
     * @param _label How to get the label to check
     * @param _expected The expected content of the tooltip
     */
    SIGHT_UI_TEST_API static void tool_tip_matches(
        tester& _tester,
        const selector& _label,
        const std::string& _expected
    );

    /**
     * Check whether the label contains the expected substring.
     * @param _tester The current tester
     * @param _label How to get the label to check
     * @param _expected The substring expected to be contained in the label
     */
    SIGHT_UI_TEST_API static void contain(tester& _tester, const selector& _label, const std::string& _expected);

    /**
     * Check whether the label exactly matches the expected result.
     * @param _tester The current tester
     * @param _label How to get the label to check
     * @param _expected The expected content of the label
     */
    SIGHT_UI_TEST_API static void exactly_match(tester& _tester, const selector& _label, const std::string& _expected);

    /**
     * Check whether the label is equal to the number with a tolerance.
     * @param _tester The current tester
     * @param _label How to get the label to check
     * @param _expected The expected value of the label
     * @param _tolerance The tolerance for the expected value
     * @param _re A regexp describing how to find the number to be checked in the label, it should be the first capture
     *            group.
     */
    SIGHT_UI_TEST_API static void equal(
        tester& _tester,
        const selector& _label,
        double _expected,
        double _tolerance,
        QRegularExpression _re = QRegularExpression("(.*)")
    );

    /**
     * Get the value within a label.
     * @param _tester The current tester
     * @param _label_name The objectName of the label
     */
    SIGHT_UI_TEST_API static std::string get(tester& _tester, const selector& _label_name);
};

} // namespace sight::ui::testCore::helper