summaryrefslogtreecommitdiff
path: root/gr-wxgui/src/python/gui.py
blob: 2f59af5935ed23ffc69feebb510777c02bd80e85 (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
#
# Copyright 2009 Free Software Foundation, Inc.
# 
# This file is part of GNU Radio
# 
# GNU Radio 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, or (at your option)
# any later version.
# 
# GNU Radio 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 GNU Radio; see the file COPYING.  If not, write to
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
# 

import wx
from gnuradio import gr

#
# Top-level display panel with vertical box sizer.  User does not create or
# subclass this class; rather, the user supplies his own class constructor
# that gets invoked with needed parameters.
#
class top_panel(wx.Panel):
    def __init__(self, frame, top_block, gui, options, args):
        wx.Panel.__init__(self, frame, -1)
        vbox = wx.BoxSizer(wx.VERTICAL)

        # Create the user's GUI class
        if gui is not None:
            self.gui = gui(frame,          # Top-level window frame
                           self,           # Parent class for user created windows
                           vbox,           # Sizer for user to add windows to
                           top_block,      # GUI-unaware flowgraph to manipulate
                           options,        # Command-line options
                           args)           # Command-line arguments

        else:
            # User hasn't made their own GUI, create our default
            # We don't have a default GUI yet either :)
            p = wx.Panel(self)
            p.SetSize((640,480))
            vbox.Add(p, 1, wx.EXPAND)
            
        self.SetSizer(vbox)
        self.SetAutoLayout(True)
        vbox.Fit(self)

    def shutdown(self):
        try:
            self.gui.shutdown()
        except AttributeError:
            pass

#
# Top-level window frame with menu and status bars.
#
class top_frame(wx.Frame):
    def __init__ (self, top_block, gui, options, args, 
                  title, nstatus, start, realtime):

        wx.Frame.__init__(self, None, -1, title)
        self.top_block = top_block

        self.CreateStatusBar(nstatus)
        mainmenu = wx.MenuBar()
        self.SetMenuBar(mainmenu)

        menu = wx.Menu()

        item = menu.Append(200, 'E&xit', 'Exit Application') # FIXME magic ID
        self.Bind(wx.EVT_MENU, self.OnCloseWindow, item)
        mainmenu.Append(menu, "&File")
        self.Bind(wx.EVT_CLOSE, self.OnCloseWindow)

        # Create main panel, creates user GUI class with supplied parameters
        self.panel = top_panel(self, top_block, gui, options, args)

        vbox = wx.BoxSizer(wx.VERTICAL)
        vbox.Add(self.panel, 1, wx.EXPAND)
        self.SetSizer(vbox)
        self.SetAutoLayout(True)
        vbox.Fit(self)

        if realtime:
            if gr.enable_realtime_scheduling() != gr.RT_OK:
                self.SetStatusText("Failed to enable realtime scheduling")

        if start and self.top_block is not None:
            self.top_block.start()

    def OnCloseWindow(self, event):
        # Give user API a chance to do something
        self.panel.shutdown()

        # Stop flowgraph as a convenience
        self.SetStatusText("Ensuring flowgraph has completed before exiting...")
        if self.top_block is not None:
            self.top_block.stop()
            self.top_block.wait()

        self.Destroy()


#
# Top-level wxPython application object.  User creates or subclasses this 
# in their GUI script.
#
class app(wx.App):
    def __init__ (self, top_block=None, gui=None, options=None, args=None, 
                  title="GNU Radio", nstatus=1, start=False, realtime=False):
        self.top_block = top_block
        self.gui = gui
        self.options = options
        self.args = args
        self.title = title
        self.nstatus = nstatus
        self.start = start
        self.realtime = realtime

        wx.App.__init__ (self, redirect=False)

    def OnInit(self):
        # Pass user parameters to top window frame
        frame = top_frame(self.top_block, self.gui, self.options, self.args,
                          self.title, self.nstatus, self.start, self.realtime)
        frame.Show(True)
        self.SetTopWindow(frame)
        return True