File: dialog.py

package info (click to toggle)
python-urwid-utils 0.1.3.dev0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 132 kB
  • sloc: python: 516; makefile: 3
file content (175 lines) | stat: -rw-r--r-- 6,247 bytes parent folder | download | duplicates (4)
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
# -*- coding: utf-8 -*-

import urwid
from urwid_utils import keys, const
from urwid_utils import PaletteEntry, Palette

BUTTONS_YES_NO = 'yes/no'
BUTTONS_OK_CANCEL = 'ok/cancel'
BUTTONS_OK = 'ok'

class DialogFrame(urwid.Frame):

    def __init__(self, *args, **kwargs):
        self.escape_func = kwargs.pop('escape_func')
        self.escape_keys = kwargs.pop('escape_keys')
        if self.escape_keys is None:
            self.escape_keys = [keys.ESCAPE,]
        urwid.Frame.__init__(self, *args, **kwargs)
    def keypress(self, size, key):
        if key in (keys.TAB, keys.UP, keys.DOWN):
            if self.focus_part == const.FOCUS_BODY:
                if key in (keys.TAB, keys.DOWN):
                    self.set_focus(const.FOCUS_FOOTER)
            elif self.focus_part == const.FOCUS_FOOTER:
                if key in (keys.TAB, keys.UP):
                    self.set_focus(const.FOCUS_BODY)
        elif key in self.escape_keys:
            self.escape_func()
            return
        return self.__super.keypress(size, key)


class DialogBase(urwid.WidgetWrap):

    palette = Palette()
    palette.dialog_body = PaletteEntry()
    palette.dialog_header = PaletteEntry()
    palette.dialog_footer = PaletteEntry()
    palette.dialog_border = PaletteEntry()
    palette.button = PaletteEntry()
    palette.reveal_focus = PaletteEntry()
    signals = ['commit']

    parent = None
    def __init__(self, width, height, data, loop, header_text=None, buttons=None, palette=None, escape_keys=None):

        width = int(width)
        if width <= 0:
            width = (const.RELATIVE, 80)
        height = int(height)
        if height <= 0:
            height = (const.RELATIVE, 80)

        if palette:
            self.palette = palette

        self.escape_keys = escape_keys

        self.loop = loop
        self.parent = self.loop.widget

        self.body = self.make_body(data)
        self.buttons = buttons
        if self.buttons is None:
            self.buttons = [("OK", True, self.on_affirmative), ("Cancel", False, self.on_negatory)]
            self.escape_keys = [keys.ESCAPE, 'q', 'Q']
        elif isinstance(self.buttons, str):
            if self.buttons == BUTTONS_YES_NO:
                self.buttons = [("Yes", True, self.on_affirmative), ("No", False, self.on_negatory)]
                self.escape_keys = [keys.ESCAPE, 'q', 'Q']
            elif self.buttons == BUTTONS_OK_CANCEL:
                self.buttons = [("OK", True, self.on_affirmative), ("Cancel", False, self.on_negatory)]
                self.escape_keys = [keys.ESCAPE, 'q', 'Q']
            elif self.buttons == BUTTONS_OK:
                self.buttons = [("OK", True, self.on_affirmative),]
                self.escape_keys = [keys.ESCAPE, 'q', 'Q', keys.ENTER]
        self.frame = self.make_frame(header_text)
        self.view = self.make_view(width, height)

        self.add_buttons(self.buttons)
        self.exitcode = None
        urwid.WidgetWrap.__init__(self, self.view)

    def make_body(self, data):
        'please implement'

    def make_frame(self, header_text):
        frame = DialogFrame(self.body, focus_part=const.FOCUS_BODY, escape_func=self.default_dialog_quit_callback, escape_keys=self.escape_keys)
        if header_text is not None:
            frame.header = urwid.Pile(
                [urwid.Text((self.palette.dialog_header.name, header_text)),
                 urwid.Divider('=')],
            )
        return frame

    def make_view(self, width, height):
        view = urwid.Padding(self.frame, (const.FIXED_LEFT, 2), (const.FIXED_RIGHT, 2))
        view = urwid.Filler(view, (const.FIXED_TOP, 1), (const.FIXED_BOTTOM, 1))
        view = urwid.AttrMap(view, self.palette.dialog_body.name)
        view = urwid.LineBox(view)
        view = urwid.Frame(view)
        view = urwid.Overlay(view, self.parent, const.CENTER, width+2, const.MIDDLE, height+2)
        return view

    def callback(self):
        'please implement'

    def add_buttons(self, buttons):
        l = []
        for name, exitcode, callback in buttons:
            b = urwid.Button(name, callback, user_data=exitcode)
            b.exitcode = exitcode
            b = urwid.AttrMap(b, attr_map=self.palette.button.name, focus_map=self.palette.reveal_focus.name)
            l.append( b )
        self.buttons = urwid.GridFlow(l, 10, 3, 1, const.CENTER)
        self.frame.footer = urwid.Pile([
            urwid.Divider('-'),
            self.buttons],
            focus_item = 1)
        self.frame.footer = urwid.AttrMap(self.frame.footer, self.palette.dialog_footer.name)

    def _button(self, *args, **kwargs):
        if len(args) == 3:
            _class, button, _status = args
            self.exitcode = button.exitcode
        self.loop.widget = self.parent

    def on_affirmative(self, *args, **kwargs):
        self._button(self, *args, **kwargs)
        urwid.emit_signal(self, 'commit', self.callback())

    def on_negatory(self, *args, **kwargs):
        self._button(self, *args, **kwargs)

    def show(self):
        self.loop.widget = self.view

    default_dialog_quit_callback = on_negatory

class YesNoDialog(DialogBase):

    def __init__(self, *args, **kwargs):
        kwargs['buttons'] = 'yes/no'
        DialogBase.__init__(self, *args, **kwargs)

    def make_body(self, data):
        return urwid.Filler(urwid.Text(data))

    def callback(self, *args, **kwargs):
        return self.exitcode

class EditDialog(DialogBase):
    def make_body(self, data):
        edit_text, editor_label = data
        self.edit = urwid.Edit(edit_text=edit_text)
        body = urwid.ListBox(urwid.SimpleListWalker([
            urwid.AttrMap(urwid.Text(editor_label), attr_map={}, focus_map=self.palette.reveal_focus.name),
            urwid.AttrMap(self.edit, attr_map={}, focus_map=self.palette.reveal_focus.name),
        ]))
        return body
    def callback(self):
        return self.edit.get_edit_text()


class NoticeDialog(DialogBase):

    def __init__(self, *args, **kwargs):
        kwargs['buttons'] = 'ok'
        DialogBase.__init__(self, *args, **kwargs)

    def make_body(self, data):
        return urwid.Filler(urwid.Text(data))

    def callback(self, *args, **kwargs):
        pass