wxPython/demo/SizedControls.py

   1 import wx
   2 import wxaddons.sized_controls as sc
   3
   4 overview = """\
   5 SizedControls is an addon library that attempts to simplify the creation of
   6 sizer-based layouts. It adds the following classes:
   7
   8 <b>SizedPanel</b>
   9
  10 This class automatically creates its own sizer (a vertical box sizer
  11 by default) and automatically adds its children to the sizer. You can change the
  12 SizedPanel's sizer type by calling panel.SetSizerType("type", [args]), where valid types are
  13 "horizontal", "vertical", "form" (a 2-col flex grid sizer), and "grid". Args include
  14 "cols" and "rows" attributes for grids. This class also applies control borders
  15 that adhere to the native platform's Human Interface Guidelines (HIG) on Win, GTK and Mac.
  16
  17 <b>SizedFrame and SizedDialog</b>
  18
  19 These classes automatically setup a SizedPanel which
  20 is appropriately positioned and given appropriate borders in accordance with the
  21 platform's HIGs.
  22
  23 Since controls are added to the parent's sizer upon creation, you don't need to
  24 use sizer.Add or even create sizers yourself. You just use SetSizerType() to
  25 change the sizer you want to use, and control.SetSizerProps() to change the
  26 sizer properties of the control. So as a result, code that used to look like this:
  27
  28 <table bgcolor="#EFEFEF"><tr><td><code>
  29 ... wx.Dialog init code...
  30
  31 panel = wx.Panel(self, -1)
  32 b1 = wx.Button(panel, -1)
  33 b2 = wx.Button(panel, -1)
  34 t1 = wx.TextCtrl(panel, -1)
  35 b3 = wx.Button(panel, -1)
  36
  37 sizer = wx.BoxSizer(wx.HORIZONTAL)
  38 sizer.Add(b1, 0, wx.ALL, 6)
  39 sizer.Add(b2, 0, wx.ALL, 6)
  40 sizer.Add(t1, 0, wx.EXPAND | wx.ALL, 6)
  41 sizer.Add(b3, 0, wx.ALL, 6)
  42 panel.SetSizer(sizer)
  43
  44 dlgSizer = wx.BoxSizer()
  45 dlgSizer.Add(panel, 1, wx.EXPAND)
  46 self.SetSizer(dlgSizer)
  47 self.SetAutoLayout(True)
  48
  49 ... rest of dialog ...</code>
  50 </td></tr></table>
  51
  52 would now look like this:
  53
  54 <table bgcolor="#EFEFEF"><tr><td><code>
  55 ... wx.Dialog init code...
  56
  57 panel = self.GetContentsPane()
  58 panel.SetSizerType("horizontal")
  59
  60 b1 = wx.Button(panel, -1)
  61 b2 = wx.Button(panel, -1)
  62
  63 t1 = wx.TextCtrl(panel, -1)
  64 t1.SetSizerProps(expand=True)
  65
  66 b3 = wx.Button(panel, -1)
  67
  68 ... rest of dialog ...</code>
  69 </td></tr></table>
  70 and the latter example will adhere to HIG spacing guidelines on all platforms,
  71 unlike the former example.
  72
  73 Please check the demos for more complete and sophisticated examples of SizedControls
  74 in action.
  75 """
  76
  77 class FormDialog(sc.SizedDialog):
  78     def __init__(self, parent, id):
  79         sc.SizedDialog.__init__(self, None, -1, "SizedForm Dialog",
  80                         style=wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER)
  81
  82         pane = self.GetContentsPane()
  83         pane.SetSizerType("form")
  84
  85         # row 1
  86         wx.StaticText(pane, -1, "Name")
  87         textCtrl = wx.TextCtrl(pane, -1, "Your name here")
  88         textCtrl.SetSizerProps(expand=True)
  89
  90         # row 2
  91         wx.StaticText(pane, -1, "Email")
  92         emailCtrl = wx.TextCtrl(pane, -1, "")
  93         emailCtrl.SetSizerProps(expand=True)
  94
  95         # row 3
  96         wx.StaticText(pane, -1, "Gender")
  97         wx.Choice(pane, -1, choices=["male", "female"])
  98
  99         # row 4
 100         wx.StaticText(pane, -1, "State")
 101         wx.TextCtrl(pane, -1, size=(60, -1)) # two chars for state
 102
 103         # row 5
 104         wx.StaticText(pane, -1, "Title")
 105
 106         # here's how to add a 'nested sizer' using sized_controls
 107         radioPane = sc.SizedPanel(pane, -1)
 108         radioPane.SetSizerType("horizontal")
 109         radioPane.SetSizerProps(expand=True)
 110
 111         # make these children of the radioPane to have them use
 112         # the horizontal layout
 113         wx.RadioButton(radioPane, -1, "Mr.")
 114         wx.RadioButton(radioPane, -1, "Mrs.")
 115         wx.RadioButton(radioPane, -1, "Dr.")
 116         # end row 5
 117
 118         # add dialog buttons
 119         self.SetButtonSizer(self.CreateStdDialogButtonSizer(wx.OK | wx.CANCEL))
 120
 121         # a little trick to make sure that you can't resize the dialog to
 122         # less screen space than the controls need
 123         self.Fit()
 124         self.SetMinSize(self.GetSize())
 125
 126
 127 class ErrorDialog(sc.SizedDialog):
 128     def __init__(self, parent, id):
 129         sc.SizedDialog.__init__(self, parent, id, "Error log viewer",
 130                                 style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER)
 131
 132         # Always use self.GetContentsPane() - this ensures that your dialog
 133         # automatically adheres to HIG spacing requirements on all platforms.
 134         # pane here is a sc.SizedPanel with a vertical sizer layout. All children
 135         # should be added to this pane, NOT to self.
 136         pane = self.GetContentsPane()
 137
 138         # first row
 139         self.listCtrl = wx.ListCtrl(pane, -1, size=(300, -1), style=wx.LC_REPORT)
 140         self.listCtrl.SetSizerProps(expand=True, proportion=1)
 141         self.ConfigureListCtrl()
 142
 143         # second row
 144         self.lblDetails = wx.StaticText(pane, -1, "Error Details")
 145
 146         # third row
 147         self.details = wx.TextCtrl(pane, -1, style=wx.TE_MULTILINE)
 148         self.details.SetSizerProps(expand=True, proportion=1)
 149
 150         # final row
 151         # since we want to use a custom button layout, we won't use the
 152         # CreateStdDialogBtnSizer here, we'll just create our own panel with
 153         # a horizontal layout and add the buttons to that.
 154         btnpane = sc.SizedPanel(pane, -1)
 155         btnpane.SetSizerType("horizontal")
 156         btnpane.SetSizerProps(expand=True)
 157
 158         self.saveBtn = wx.Button(btnpane, wx.ID_SAVE)
 159         spacer = sc.SizedPanel(btnpane, -1)
 160         spacer.SetSizerProps(expand=True, proportion=1)
 161
 162         self.clearBtn = wx.Button(btnpane, -1, "Clear")
 163
 164         self.Fit()
 165         self.SetMinSize(self.GetSize())
 166
 167     def ConfigureListCtrl(self):
 168         self.listCtrl.InsertColumn(0, "Time")
 169         self.listCtrl.InsertColumn(1, "Error Message")
 170         self.listCtrl.SetColumnWidth(0, 100)
 171         self.listCtrl.SetColumnWidth(1, 280)
 172
 173 #---------------------------------------------------------------------------
 174
 175 class TestPanel(wx.Panel):
 176     def __init__(self, parent, log):
 177         self.log = log
 178         self.parent = parent
 179         wx.Panel.__init__(self, parent, -1)
 180
 181         b = wx.Button(self, -1, "Sized Controls Form Dialog", (50,50))
 182         self.Bind(wx.EVT_BUTTON, self.OnFormButton, b)
 183
 184         b2 = wx.Button(self, -1, "Sized Controls Error Dialog", (50,90))
 185         self.Bind(wx.EVT_BUTTON, self.OnErrorButton, b2)
 186
 187
 188     def OnFormButton(self, evt):
 189         print
 190         dlg = FormDialog(self, -1)
 191         dlg.CenterOnScreen()
 192
 193         # this does not return until the dialog is closed.
 194         val = dlg.ShowModal()
 195
 196         if val == wx.ID_OK:
 197             self.log.WriteText("You pressed OK\n")
 198         else:
 199             self.log.WriteText("You pressed Cancel\n")
 200
 201         dlg.Destroy()
 202
 203     def OnErrorButton(self, evt):
 204
 205         dlg = ErrorDialog(self, -1)
 206         dlg.CenterOnScreen()
 207
 208         # this does not return until the dialog is closed.
 209         val = dlg.ShowModal()
 210
 211         if val == wx.ID_OK:
 212             self.log.WriteText("You pressed OK\n")
 213         else:
 214             self.log.WriteText("You pressed Cancel\n")
 215
 216         dlg.Destroy()
 217
 218 def runTest(frame, nb, log):
 219     win = TestPanel(nb, log)
 220     return win
 221
 222 if __name__ == "__main__":
 223     app = wx.PySimpleApp()
 224     dlg = FormDialog()
 225     dlg.ShowModal()