Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/result_bar.py
blob: 6b2996673fb0a1da750742727b7ddbfe97e12f39 (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
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# -*- coding: utf-8 -*-

"""
HitTheBalls : hit the ball(s) with the good result.
Copyright (C) 2013  Laurent Bernabe <laurent.bernabe@gmail.com>

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 3 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.  If not, see <http://www.gnu.org/licenses/>.
"""

"""
Manages the result bar : this bar that tells to the user which result
he must solve.
"""


class ResultBar(object):

    """
    A bar which tells to the player which result he must solve by hitting
    matching balls.
    """

    def __init__(self, txt_font, txt_color, bg_color, header, width,
                 lftp_edge=(0, 0)):
        """
        Constructor:
        Height will be computed internally thanks to the header value and the
        given font.
        txt_font : text font => olpcgames.pangofont
        txt_color : text color => Tuple of 3 integers in [0,255]
        bg_color : background color => Tuple of 3 integers in [0,255]
        header : text start, such as 'Hit balls with result : ' => string
        width : width of the bar => integer
        lftp_edge : coordinates of the left-top edge => tuple of 2 integers.
        """
        self._INSETS = 4
        self._txt_font = txt_font
        self._txt_color = txt_color
        self._bg_color = bg_color
        self._header = header
        self._width = width
        self._lftp_edge = lftp_edge
        self._height = txt_font.size(header)[1] + 2 * self._INSETS

    def get_insets(self):
        """
        Accessor to the component insets.
        => integer
        """
        return self._INSETS

    def get_text_font(self):
        """
        Accesssor to the text font.
        => olpcgames.pangofont
        """
        return self._txt_font

    def get_foreground(self):
        """
        Accessor to the text color.
        => Tuple of 3 integers in [0,255].
        """
        return self._txt_color

    def get_background(self):
        """
        Accessor to the bar background color.
        => Tuple of 3 integers in [0,255].
        """
        return self._bg_color

    def get_header(self):
        """
        Accessor to the header (text start, such as 'Hit balls with result : ')
        => string
        """
        return self._header

    def get_width(self):
        """
        Accessor to the width.
        => integer
        """
        return self._width

    def get_height(self):
        """
        Accesssor to the height.
        => integer
        """
        return self._height

    def get_edge(self):
        """
        Accessor to the coordinates of the left-top edge.
        => Tuple of 2 integers.
        """
        return self._lftp_edge

    def get_result(self):
        """
        Accessor to the result.
        Careful ! This might throw an NameError, as result may not be defined
        yet.
        => integer
        """
        try:
            return self._result
        except AttributeError:
            raise NameError

    def set_result(self, result):
        """
        Sets the result of the bar.
        result : the result to solve => integer
        """
        self._result = result

    def remove_result(self):
        """
        Delete the result value.
        """
        try:
            del self._result
        except AttributeError:
            pass