wxGUI: menu customization implemented by Vaclav Petras (CTU in Prague)

during GRASS Community Sprint in Prague 2011


git-svn-id: https://svn.osgeo.org/grass/grass/trunk@46397 15284696-431f-4ddb-bdfa-cd5b030d7da7

gui/wxpython/gui_modules/gselect.py

@@ -27,6 +27,7 @@ COPYING that comes with GRASS for details.
 
 @author Michael Barton
 @author Martin Landa <landa.martin gmail.com>
+@author Vaclav Petras <wenzeslaus gmail.com> (menu customization)
 """
 
 import os
@@ -238,7 +239,10 @@ class TreeCtrlComboPopup(wx.combo.ComboPopup):
             self.seltree.SelectItem(found)
 
     def GetAdjustedSize(self, minWidth, prefHeight, maxHeight):
-        return wx.Size(minWidth, min(200, maxHeight))
+        """!Reads UserSettings to get height (which was 200 in old implementation).
+        """
+        height = UserSettings.Get(group = 'appearance', key = 'gSelectPopupHeight', subkey = 'value')
+        return wx.Size(minWidth, min(height, maxHeight))
 
     def _getElementList(self, element, mapsets = None, elements = None, exclude = False):
         """!Get list of GIS elements in accessible mapsets and display as tree

gui/wxpython/gui_modules/menu.py

@@ -11,6 +11,10 @@ This program is free software under the GNU General Public License
 (>=v2). Read the file COPYING that comes with GRASS for details.
 
 @author Martin Landa <landa.martin gmail.com>
+@author Pawel Netzel (menu customization)
+@author Milena Nowotarska (menu customization)
+@author Robert Szczepanek (menu customization)
+@author Vaclav Petras <wenzeslaus gmail.com> (menu customization)
 """
 
 import wx
@@ -18,6 +22,8 @@ import wx
 import globalvar
 import utils
 
+from preferences import globalSettings as UserSettings
+
 class Menu(wx.MenuBar):
     def __init__(self, parent, data):
         """!Creates menubar"""
@@ -26,6 +32,8 @@ class Menu(wx.MenuBar):
         self.menudata = data
         self.menucmd  = dict()
         
+        self.menustyle = UserSettings.Get(group='appearance', key='menustyle', subkey='selection')
+        
         for eachMenuData in self.menudata.GetMenu():
             for eachHeading in eachMenuData:
                 menuLabel = eachHeading[0]
@@ -41,21 +49,28 @@ class Menu(wx.MenuBar):
                 subMenu = self._createMenu(eachItem[1])
                 menu.AppendMenu(wx.ID_ANY, label, subMenu)
             else:
-                self._createMenuItem(menu, *eachItem)
+                self._createMenuItem(menu, *eachItem, menustyle = self.menustyle)
         
         self.parent.Bind(wx.EVT_MENU_HIGHLIGHT_ALL, self.OnMenuHighlight)
         
         return menu
 
     def _createMenuItem(self, menu, label, help, handler, gcmd, keywords,
-                        shortcut = '', kind = wx.ITEM_NORMAL):
-        """!Creates menu items"""
+                        shortcut = '', kind = wx.ITEM_NORMAL, menustyle = 0):
+        """!Creates menu items
+        There are three menu styles (menu item text styles).
+        1 -- label only, 2 -- label and cmd name, 3 -- cmd name only
+        """
         if not label:
             menu.AppendSeparator()
             return
         
         if len(gcmd) > 0:
             helpString = gcmd + ' -- ' + help
+            if menustyle == 1:
+                label += '   [' + gcmd + ']'
+            elif menustyle == 2:
+                label = '      [' + gcmd + ']'
         else:
             helpString = help
         

gui/wxpython/gui_modules/preferences.py

@@ -4,6 +4,9 @@
 @brief User preferences dialog
 
 Sets default display font, etc.
+If you want to add some value to settings you have to add default value 
+to defaultSettings and set constraints in internalSettings in Settings class.
+Everything can be used in PreferencesDialog.
 
 Classes:
  - Settings
@@ -20,6 +23,7 @@ for details.
 
 @author Michael Barton (Arizona State University)
 @author Martin Landa <landa.martin gmail.com>
+@author Vaclav Petras <wenzeslaus gmail.com> (menu customization)
 """
 
 import os
@@ -49,6 +53,10 @@ import utils
 import globalvar
 from debug import Debug as Debug
 
+from wx.lib.newevent import NewEvent
+
+wxSettingsChanged, EVT_SETTINGS_CHANGED = NewEvent()
+
 class Settings:
     """!Generic class where to store settings"""
     def __init__(self):
@@ -100,6 +108,24 @@ class Settings:
                     },
                 },
             #
+            # appearance
+            #
+            'appearance': {
+                'outputfont' : {
+                    'type' : 'Courier New',
+                    'size': '10',
+                    },
+                'menustyle' : {
+                    'selection' : 1
+                    },
+                'gSelectPopupHeight' : {
+                    'value' : 200
+                    },
+                'iconTheme' : {
+                    'type' : 'grass'
+                    },
+                },
+            #
             # display
             #
             'display': {
@@ -107,10 +133,6 @@ class Settings:
                     'type' : '',
                     'encoding': 'ISO-8859-1',
                     },
-                'outputfont' : {
-                    'type' : 'Courier New',
-                    'size': '10',
-                    },
                 'driver': {
                     'type': 'cairo'
                     },
@@ -145,14 +167,6 @@ class Settings:
                     },
                 },
             #
-            # advanced
-            #
-            'advanced' : {
-                'iconTheme' : {
-                    'type' : 'grass'
-                    },
-                },
-            #
             # Attribute Table Manager
             #
             'atm' : {
@@ -615,10 +629,20 @@ class Settings:
              _("Expand all"))
         self.internalSettings['atm']['leftDbClick']['choices'] = (_('Edit selected record'),
                                                                   _('Display selected'))
-        self.internalSettings['advanced']['iconTheme']['choices'] = ('grass',)
+        
         self.internalSettings['cmd']['verbosity']['choices'] = ('grassenv',
                                                                 'verbose',
                                                                 'quiet')
+                                                                
+        self.internalSettings['appearance']['iconTheme']['choices'] = ('grass',)
+        self.internalSettings['appearance']['menustyle']['choices'] = \
+                   (_("Classic (labels only)"),
+                    _("Combined (labels and module names)"),
+                    _("Professional (module names only)"))
+        self.internalSettings['appearance']['gSelectPopupHeight']['min'] = 50
+        # there is also maxHeight given to TreeCtrlComboPopup.GetAdjustedSize
+        self.internalSettings['appearance']['gSelectPopupHeight']['max'] = 1000
+        
         self.internalSettings['display']['driver']['choices'] = ['cairo', 'png']
         self.internalSettings['display']['statusbarMode']['choices'] = globalvar.MAP_DISPLAY_STATUSBAR_MODE
 
@@ -999,9 +1023,13 @@ class PreferencesBaseDialog(wx.Dialog):
                 value = win.SetValue(value)
         
     def OnApply(self, event):
-        """!Button 'Apply' pressed"""
+        """!Button 'Apply' pressed
+        Posts event EVT_SETTINGS_CHANGED.
+        """
         if self._updateSettings():
             self.parent.goutput.WriteLog(_('Settings applied to current session but not saved'))
+            event = wxSettingsChanged()
+            wx.PostEvent(self, event)
             self.Close()
 
     def OnCloseWindow(self, event):
@@ -1012,10 +1040,14 @@ class PreferencesBaseDialog(wx.Dialog):
         self.Close()
         
     def OnSave(self, event):
-        """!Button 'Save' pressed"""
+        """!Button 'Save' pressed
+        Posts event EVT_SETTINGS_CHANGED.
+        """
         if self._updateSettings():
             file = self.settings.SaveToFile()
             self.parent.goutput.WriteLog(_('Settings saved to file \'%s\'.') % file)
+            event = wxSettingsChanged()
+            wx.PostEvent(self, event)
             self.Close()
 
     def _updateSettings(self):
@@ -1058,7 +1090,7 @@ class PreferencesBaseDialog(wx.Dialog):
 
 class PreferencesDialog(PreferencesBaseDialog):
     """!User preferences dialog"""
-    def __init__(self, parent, title = _("GUI settings"),
+    def __init__(self, parent, title = _("GUI Settings"),
                  settings = globalSettings):
         
         PreferencesBaseDialog.__init__(self, parent = parent, title = title,
@@ -1066,12 +1098,12 @@ class PreferencesDialog(PreferencesBaseDialog):
         
         # create notebook pages
         self._CreateGeneralPage(self.notebook)
+        self._CreateAppearancePage(self.notebook)
         self._CreateDisplayPage(self.notebook)
         self._CreateCmdPage(self.notebook)
         self._CreateAttributeManagerPage(self.notebook)
         self._CreateProjectionPage(self.notebook)
         self._CreateWorkspacePage(self.notebook)
-        self._CreateAdvancedPage(self.notebook)
         
         self.SetMinSize(self.GetBestSize())
         self.SetSize(self.size)
@@ -1161,6 +1193,7 @@ class PreferencesDialog(PreferencesBaseDialog):
         gridSizer.Add(item=askOnQuit,
                       pos=(row, 0), span=(1, 2))
         
+        
         sizer.Add(item=gridSizer, proportion=1, flag=wx.ALL | wx.EXPAND, border=5)
         border.Add(item=sizer, proportion=0, flag=wx.LEFT | wx.RIGHT | wx.BOTTOM | wx.EXPAND, border=3)
 
@@ -1168,11 +1201,11 @@ class PreferencesDialog(PreferencesBaseDialog):
         
         return panel
 
-    def _CreateDisplayPage(self, notebook):
+    def _CreateAppearancePage(self, notebook):
         """!Create notebook page for display settings"""
    
         panel = wx.Panel(parent=notebook, id=wx.ID_ANY)
-        notebook.AddPage(page=panel, text=_("Display"))
+        notebook.AddPage(page=panel, text=_("Appearance"))
 
         border = wx.BoxSizer(wx.VERTICAL)
 
@@ -1185,35 +1218,154 @@ class PreferencesDialog(PreferencesBaseDialog):
         #
         # font settings
         #
+        sizer.Add(item=gridSizer, proportion=1, flag=wx.ALL | wx.EXPAND, border=5)
+        border.Add(item=sizer, proportion=0, flag=wx.ALL | wx.EXPAND, border=3)
+
         row = 0
         gridSizer.Add(item=wx.StaticText(parent=panel, id=wx.ID_ANY,
-                                         label=_("Default font for GRASS displays:")),
+                                         label=_("Font for command output:")),
                       flag=wx.ALIGN_LEFT |
                       wx.ALIGN_CENTER_VERTICAL,
                       pos=(row, 0))
-        fontButton = wx.Button(parent=panel, id=wx.ID_ANY,
+        outfontButton = wx.Button(parent=panel, id=wx.ID_ANY,
                                label=_("Set font"), size=(100, -1))
-        gridSizer.Add(item=fontButton,
+        gridSizer.Add(item=outfontButton,
                       flag=wx.ALIGN_RIGHT |
                       wx.ALIGN_CENTER_VERTICAL,
                       pos=(row, 1))
 
+        #
+        # appearence
+        #
+        box   = wx.StaticBox (parent=panel, id=wx.ID_ANY, label=" %s " % _("Appearance settings"))
+        sizer = wx.StaticBoxSizer(box, wx.VERTICAL)
+
+        gridSizer = wx.GridBagSizer (hgap=3, vgap=3)
+        gridSizer.AddGrowableCol(0)
+
+        #
+        # menu style
+        #
+        row = 0
+        
+        gridSizer.Add(item = wx.StaticText(parent = panel, id = wx.ID_ANY,
+                                         label = _("Menu style:")),
+                      flag = wx.ALIGN_LEFT |
+                      wx.ALIGN_CENTER_VERTICAL,
+                      pos = (row, 0))
+        listOfStyles = self.settings.Get(group = 'appearance', key = 'menustyle',
+                                         subkey = 'choices', internal = True)
+        
+        menuItemText = wx.Choice(parent = panel, id = wx.ID_ANY, size = (300, -1),
+                                 choices = listOfStyles,
+                                 name = "GetSelection")
+        menuItemText.SetSelection(self.settings.Get(group='appearance', key='menustyle', subkey='selection'))
+        
+        self.winId['appearance:menustyle:selection'] = menuItemText.GetId()
+        
+        gridSizer.Add(item=menuItemText,
+                      flag=wx.ALIGN_RIGHT,
+                      pos=(row, 1))
+        
+        #
+        # gselect.TreeCtrlComboPopup height
+        #
+        row += 1
+        
+        gridSizer.Add(item=wx.StaticText(parent=panel, id=wx.ID_ANY,
+                                         label=_("Height of map selection popup window (in pixels):")),
+                      flag=wx.ALIGN_LEFT |
+                      wx.ALIGN_CENTER_VERTICAL,
+                      pos=(row, 0))
+        min = self.settings.Get(group='appearance', key='gSelectPopupHeight', subkey='min', internal=True)
+        max = self.settings.Get(group='appearance', key='gSelectPopupHeight', subkey='max', internal=True)
+        value = self.settings.Get(group='appearance', key='gSelectPopupHeight', subkey='value')
+        
+        popupHeightSpin = wx.SpinCtrl(parent=panel, id=wx.ID_ANY, size=(100, -1))
+        popupHeightSpin.SetRange(min,max)
+        popupHeightSpin.SetValue(value)
+        
+        self.winId['appearance:gSelectPopupHeight:value'] = popupHeightSpin.GetId()
+        
+        gridSizer.Add(item=popupHeightSpin,
+                      flag=wx.ALIGN_RIGHT,
+                      pos=(row, 1))
+        
+        
+        #
+        # icon theme
+        #
+        row += 1
+        gridSizer.Add(item=wx.StaticText(parent=panel, id=wx.ID_ANY,
+                                         label=_("Icon theme:")),
+                       flag=wx.ALIGN_LEFT |
+                       wx.ALIGN_CENTER_VERTICAL,
+                       pos=(row, 0))
+        iconTheme = wx.Choice(parent=panel, id=wx.ID_ANY, size=(100, -1),
+                              choices=self.settings.Get(group='appearance', key='iconTheme',
+                                                        subkey='choices', internal=True),
+                              name="GetStringSelection")
+        iconTheme.SetStringSelection(self.settings.Get(group='appearance', key='iconTheme', subkey='type'))
+        self.winId['appearance:iconTheme:type'] = iconTheme.GetId()
+
+        gridSizer.Add(item=iconTheme,
+                      flag=wx.ALIGN_RIGHT |
+                      wx.ALIGN_CENTER_VERTICAL,
+                      pos=(row, 1))
+        
+        row += 1
+        gridSizer.Add(item=wx.StaticText(parent=panel, id=wx.ID_ANY,
+                                         label=_("Note: For changing the icon theme, "
+                                                 "you must save the settings and restart this GUI.")),
+                      flag=wx.ALIGN_CENTER_VERTICAL,
+                      pos=(row, 0), span=(1, 2))
+                              
+
         sizer.Add(item=gridSizer, proportion=1, flag=wx.ALL | wx.EXPAND, border=5)
-        border.Add(item=sizer, proportion=0, flag=wx.ALL | wx.EXPAND, border=3)
+        border.Add(item=sizer, proportion=0, flag=wx.LEFT | wx.RIGHT | wx.BOTTOM | wx.EXPAND, border=3)
+        
+        panel.SetSizer(border)
+                
+        # bindings
+        outfontButton.Bind(wx.EVT_BUTTON, self.OnSetOutputFont)
+        
+        return panel
+
+
+
+    def _CreateDisplayPage(self, notebook):
+        """!Create notebook page for display settings"""
+   
+        panel = wx.Panel(parent=notebook, id=wx.ID_ANY)
+        notebook.AddPage(page=panel, text=_("Map Display"))
+
+        border = wx.BoxSizer(wx.VERTICAL)
 
-        row = 1
+        box   = wx.StaticBox (parent=panel, id=wx.ID_ANY, label=" %s " % _("Font settings"))
+        sizer = wx.StaticBoxSizer(box, wx.VERTICAL)
+
+        gridSizer = wx.GridBagSizer (hgap=3, vgap=3)
+        gridSizer.AddGrowableCol(0)
+
+        #
+        # font settings
+        #
+        row = 0
         gridSizer.Add(item=wx.StaticText(parent=panel, id=wx.ID_ANY,
-                                         label=_("Font for command output:")),
+                                         label=_("Default font for GRASS displays:")),
                       flag=wx.ALIGN_LEFT |
                       wx.ALIGN_CENTER_VERTICAL,
                       pos=(row, 0))
-        outfontButton = wx.Button(parent=panel, id=wx.ID_ANY,
+        fontButton = wx.Button(parent=panel, id=wx.ID_ANY,
                                label=_("Set font"), size=(100, -1))
-        gridSizer.Add(item=outfontButton,
+        gridSizer.Add(item=fontButton,
                       flag=wx.ALIGN_RIGHT |
                       wx.ALIGN_CENTER_VERTICAL,
                       pos=(row, 1))
 
+        sizer.Add(item=gridSizer, proportion=1, flag=wx.ALL | wx.EXPAND, border=5)
+        border.Add(item=sizer, proportion=0, flag=wx.ALL | wx.EXPAND, border=3)
+
         #
         # display settings
         #
@@ -1223,6 +1375,7 @@ class PreferencesDialog(PreferencesBaseDialog):
         gridSizer = wx.GridBagSizer (hgap=3, vgap=3)
         gridSizer.AddGrowableCol(0)
 
+        
         #
         # display driver
         #
@@ -1328,7 +1481,6 @@ class PreferencesDialog(PreferencesBaseDialog):
                 
         # bindings
         fontButton.Bind(wx.EVT_BUTTON, self.OnSetFont)
-        outfontButton.Bind(wx.EVT_BUTTON, self.OnSetOutputFont)
         
         return panel
 
@@ -1790,54 +1942,7 @@ class PreferencesDialog(PreferencesBaseDialog):
         panel.SetSizer(border)
         
         return panel
-
-    def _CreateAdvancedPage(self, notebook):
-        """!Create notebook page for advanced settings"""
-        panel = wx.Panel(parent=notebook, id=wx.ID_ANY)
-        notebook.AddPage(page=panel, text=_("Advanced"))
-
-        border = wx.BoxSizer(wx.VERTICAL)
-        box   = wx.StaticBox (parent=panel, id=wx.ID_ANY, label=" %s " % _("Advanced settings"))
-        sizer = wx.StaticBoxSizer(box, wx.VERTICAL)
-
-        gridSizer = wx.GridBagSizer (hgap=3, vgap=3)
-        gridSizer.AddGrowableCol(0)
-
-        row = 0
-        #
-        # icon theme
-        #
-        gridSizer.Add(item=wx.StaticText(parent=panel, id=wx.ID_ANY,
-                                         label=_("Icon theme:")),
-                       flag=wx.ALIGN_LEFT |
-                       wx.ALIGN_CENTER_VERTICAL,
-                       pos=(row, 0))
-        iconTheme = wx.Choice(parent=panel, id=wx.ID_ANY, size=(125, -1),
-                              choices=self.settings.Get(group='advanced', key='iconTheme',
-                                                        subkey='choices', internal=True),
-                              name="GetStringSelection")
-        iconTheme.SetStringSelection(self.settings.Get(group='advanced', key='iconTheme', subkey='type'))
-        self.winId['advanced:iconTheme:type'] = iconTheme.GetId()
-
-        gridSizer.Add(item=iconTheme,
-                      flag=wx.ALIGN_RIGHT |
-                      wx.ALIGN_CENTER_VERTICAL,
-                      pos=(row, 1))
-        
-        row += 1
-        gridSizer.Add(item=wx.StaticText(parent=panel, id=wx.ID_ANY,
-                                         label=_("Note: For changing the icon theme, "
-                                                 "you must save the settings and restart this GUI.")),
-                      flag=wx.ALIGN_CENTER_VERTICAL,
-                      pos=(row, 0), span=(1, 2))
-                      
-        sizer.Add(item=gridSizer, proportion=1, flag=wx.ALL | wx.EXPAND, border=5)
-        border.Add(item=sizer, proportion=1, flag=wx.ALL | wx.EXPAND, border=3)
-
-        panel.SetSizer(border)
-        
-        return panel
-
+    
     def OnCheckColorTable(self, event):
         """!Set/unset default color table"""
         win = self.FindWindowById(self.winId['cmd:rasterColorTable:selection'])

gui/wxpython/wxgui.py

@@ -17,6 +17,7 @@ for details.
 @author Michael Barton (Arizona State University)
 @author Jachym Cepicky (Mendel University of Agriculture)
 @author Martin Landa <landa.martin gmail.com>
+@author Vaclav Petras <wenzeslaus gmail.com> (menu customization)
 """
 
 import sys
@@ -123,11 +124,9 @@ class GMFrame(wx.Frame):
         self.dialogs['atm'] = list()
         
         # creating widgets
-        self.menubar = menu.Menu(parent = self, data = menudata.ManagerData())
-        self.SetMenuBar(self.menubar)
-        self.menucmd = self.menubar.GetCmd()
+        self._createMenuBar()
         self.statusbar = self.CreateStatusBar(number=1)
-        self.notebook  = self.__createNoteBook()
+        self.notebook  = self._createNoteBook()
         self.toolbars = { 'main'  : LayerManagerToolbar(parent = self),
                           'tools' : ToolsToolbar(parent = self) }
         
@@ -209,7 +208,13 @@ class GMFrame(wx.Frame):
             self.curr_page.maptree.mapdisplay.Raise()
         wx.CallAfter(self.Raise)
         
-    def __createNoteBook(self):
+    def _createMenuBar(self):
+        """!Creates menu bar"""
+        self.menubar = menu.Menu(parent = self, data = menudata.ManagerData())
+        self.SetMenuBar(self.menubar)
+        self.menucmd = self.menubar.GetCmd()
+        
+    def _createNoteBook(self):
         """!Creates notebook widgets"""
         if globalvar.hasAgw:
             self.notebook = FN.FlatNotebook(parent = self, id = wx.ID_ANY, agwStyle = globalvar.FNPageDStyle)
@@ -262,6 +267,12 @@ class GMFrame(wx.Frame):
         if self.workspaceFile:
             self.SetTitle(self.baseTitle + " - " +  os.path.basename(self.workspaceFile) + '*')
         
+    def OnSettingsChanged(self, event):
+        """!Here can be functions which have to be called after EVT_SETTINGS_CHANGED. 
+        Now recreates menu only.
+        """
+        self._createMenuBar()
+        
     def OnGCPManager(self, event):
         """!Launch georectifier module
         """
@@ -1003,7 +1014,9 @@ class GMFrame(wx.Frame):
             dlg = preferences.PreferencesDialog(parent = self)
             self.dialogs['preferences'] = dlg
             self.dialogs['preferences'].CenterOnScreen()
-
+            
+            dlg.Bind(preferences.EVT_SETTINGS_CHANGED, self.OnSettingsChanged)
+        
         self.dialogs['preferences'].ShowModal()
         
     def OnHelp(self, event):