def _langBox(self, par, k, v):
"""Return box"""
langBox = wx.FlexGridSizer(cols=4, vgap=5, hgap=5)
tkey = StaticText(parent=par, id=wx.ID_ANY, label=k.upper())
langBox.Add(tkey)
try:
tgood = StaticText(parent=par,
id=wx.ID_ANY,
label=_("%d translated" % v['good']))
tgood.SetForegroundColour(wx.Colour(35, 142, 35))
langBox.Add(tgood)
except:
tgood = StaticText(parent=par, id=wx.ID_ANY, label="")
langBox.Add(tgood)
try:
tfuzzy = StaticText(parent=par,
id=wx.ID_ANY,
label=_(" %d fuzzy" % v['fuzzy']))
tfuzzy.SetForegroundColour(wx.Colour(255, 142, 0))
langBox.Add(tfuzzy)
except:
tfuzzy = StaticText(parent=par, id=wx.ID_ANY, label="")
langBox.Add(tfuzzy)
try:
tbad = StaticText(parent=par,
id=wx.ID_ANY,
label=_(" %d untranslated" % v['bad']))
tbad.SetForegroundColour(wx.Colour(255, 0, 0))
langBox.Add(tbad)
except:
tbad = StaticText(parent=par, id=wx.ID_ANY, label="")
langBox.Add(tbad)
return langBox
class SbMask(SbItem):
"""StaticText to show whether mask is activated."""
def __init__(self, mapframe, statusbar, position=0):
SbItem.__init__(self, mapframe, statusbar, position)
self.name = "mask"
self.widget = StaticText(parent=self.statusbar, id=wx.ID_ANY, label=_("MASK"))
self.widget.SetForegroundColour(wx.Colour(255, 0, 0))
self.widget.Hide()
def Update(self):
if grass.find_file(
name="MASK", element="cell", mapset=grass.gisenv()["MAPSET"]
)["name"]:
self.Show()
else:
self.Hide()
def __init__(self, parent, data=None):
wx.Dialog.__init__(self,
parent,
id=wx.ID_ANY,
title=_("Query results"),
size=(420, 400),
style=wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER)
# send query output to console
self.redirectOutput = Signal('QueryDialog.redirectOutput')
self.data = data
self.panel = wx.Panel(self, id=wx.ID_ANY)
self.mainSizer = wx.BoxSizer(wx.VERTICAL)
helpText = StaticText(
self.panel,
wx.ID_ANY,
label=_("Right click to copy selected values to clipboard."))
helpText.SetForegroundColour(
wx.SystemSettings.GetColour(wx.SYS_COLOUR_GRAYTEXT))
self.mainSizer.Add(helpText, proportion=0, flag=wx.ALL, border=5)
self._colNames = [_("Feature"), _("Value")]
self._model = QueryTreeBuilder(self.data, column=self._colNames[1])
self.tree = TreeListView(model=self._model,
parent=self.panel,
columns=self._colNames,
style=wx.TR_DEFAULT_STYLE | wx.TR_HIDE_ROOT
| wx.TR_FULL_ROW_HIGHLIGHT | wx.TR_MULTIPLE)
self.tree.SetColumnWidth(0, 220)
self.tree.SetColumnWidth(1, 1000)
self.tree.ExpandAll(self._model.root)
self.tree.RefreshItems()
self.tree.contextMenu.connect(self.ShowContextMenu)
self.mainSizer.Add(self.tree,
proportion=1,
flag=wx.EXPAND | wx.ALL,
border=5)
close = Button(self.panel, id=wx.ID_CLOSE)
close.Bind(wx.EVT_BUTTON, lambda event: self.Close())
copy = Button(self.panel,
id=wx.ID_ANY,
label=_("Copy all to clipboard"))
copy.Bind(wx.EVT_BUTTON, self.Copy)
self.Bind(wx.EVT_CLOSE, self.OnClose)
self.redirect = wx.CheckBox(self.panel, label=_("Redirect to console"))
self.redirect.SetValue(False)
self.redirect.Bind(wx.EVT_CHECKBOX,
lambda evt: self._onRedirect(evt.IsChecked()))
hbox = wx.BoxSizer(wx.HORIZONTAL)
hbox.Add(self.redirect,
proportion=0,
flag=wx.EXPAND | wx.RIGHT,
border=5)
hbox.AddStretchSpacer(1)
hbox.Add(copy, proportion=0, flag=wx.EXPAND | wx.RIGHT, border=5)
hbox.Add(close, proportion=0, flag=wx.EXPAND | wx.ALL, border=0)
self.mainSizer.Add(hbox,
proportion=0,
flag=wx.EXPAND | wx.ALL,
border=5)
self.panel.SetSizer(self.mainSizer)
self.mainSizer.Fit(self.panel)
# for Windows
self.SendSizeEvent()
def _layout(self):
"""Do layout"""
self.outputSizer = wx.BoxSizer(wx.VERTICAL)
progressSizer = wx.BoxSizer(wx.HORIZONTAL)
btnSizer = wx.BoxSizer(wx.HORIZONTAL)
if self._gcstyle & GC_PROMPT:
outBtnSizer = wx.StaticBoxSizer(self.outputBox, wx.HORIZONTAL)
cmdBtnSizer = wx.StaticBoxSizer(self.cmdBox, wx.HORIZONTAL)
else:
outBtnSizer = wx.BoxSizer(wx.HORIZONTAL)
cmdBtnSizer = wx.BoxSizer(wx.HORIZONTAL)
if self._gcstyle & GC_PROMPT:
promptSizer = wx.BoxSizer(wx.VERTICAL)
promptSizer.Add(
self.cmdPrompt,
proportion=1,
flag=wx.EXPAND | wx.LEFT | wx.RIGHT | wx.TOP,
border=3,
)
helpText = StaticText(
self.panelPrompt,
id=wx.ID_ANY,
label="Press Tab to display command help, Ctrl+Space to autocomplete",
)
helpText.SetForegroundColour(
wx.SystemSettings.GetColour(wx.SYS_COLOUR_GRAYTEXT)
)
promptSizer.Add(helpText, proportion=0, flag=wx.EXPAND | wx.LEFT, border=5)
self.outputSizer.Add(
self.cmdOutput, proportion=1, flag=wx.EXPAND | wx.ALL, border=3
)
if self._gcstyle & GC_PROMPT:
proportion = 1
else:
proportion = 0
outBtnSizer.AddStretchSpacer()
outBtnSizer.Add(
self.btnOutputClear,
proportion=proportion,
flag=wx.ALIGN_LEFT | wx.LEFT | wx.RIGHT | wx.BOTTOM,
border=5,
)
outBtnSizer.Add(
self.btnOutputSave,
proportion=proportion,
flag=wx.RIGHT | wx.BOTTOM,
border=5,
)
cmdBtnSizer.Add(
self.btnCmdProtocol,
proportion=1,
flag=wx.ALIGN_CENTER
| wx.ALIGN_CENTER_VERTICAL
| wx.LEFT
| wx.RIGHT
| wx.BOTTOM,
border=5,
)
cmdBtnSizer.Add(
self.btnCmdClear,
proportion=1,
flag=wx.ALIGN_CENTER | wx.RIGHT | wx.BOTTOM,
border=5,
)
progressSizer.Add(
self.btnCmdAbort, proportion=0, flag=wx.ALL | wx.ALIGN_CENTER, border=5
)
progressSizer.Add(
self.progressbar,
proportion=1,
flag=wx.ALIGN_CENTER | wx.RIGHT | wx.TOP | wx.BOTTOM,
border=5,
)
self.panelProgress.SetSizer(progressSizer)
progressSizer.Fit(self.panelProgress)
btnSizer.Add(outBtnSizer, proportion=1, flag=wx.ALL | wx.ALIGN_CENTER, border=5)
btnSizer.Add(
cmdBtnSizer,
proportion=1,
flag=wx.ALIGN_CENTER | wx.TOP | wx.BOTTOM | wx.RIGHT,
border=5,
)
self.outputSizer.Add(self.panelProgress, proportion=0, flag=wx.EXPAND)
self.outputSizer.Add(btnSizer, proportion=0, flag=wx.EXPAND)
self.outputSizer.Fit(self)
self.outputSizer.SetSizeHints(self)
self.panelOutput.SetSizer(self.outputSizer)
self.outputSizer.FitInside(self.panelOutput)
if self._gcstyle & GC_PROMPT:
promptSizer.Fit(self)
promptSizer.SetSizeHints(self)
self.panelPrompt.SetSizer(promptSizer)
# split window
if self._gcstyle & GC_PROMPT:
self.SplitHorizontally(self.panelOutput, self.panelPrompt, -50)
else:
self.SplitHorizontally(self.panelOutput, self.panelPrompt, -45)
self.Unsplit()
self.SetMinimumPaneSize(self.btnCmdClear.GetSize()[1] + 25)
self.SetSashGravity(1.0)
self.outputSizer.Hide(self.panelProgress)
# layout
self.SetAutoLayout(True)
self.Layout()
class GRASSStartup(wx.Frame):
exit_success = 0
# 2 is file not found from python interpreter
exit_user_requested = 5
"""GRASS start-up screen"""
def __init__(self,
parent=None,
id=wx.ID_ANY,
style=wx.DEFAULT_FRAME_STYLE):
#
# GRASS variables
#
self.gisbase = os.getenv("GISBASE")
self.grassrc = sgui.read_gisrc()
self.gisdbase = self.GetRCValue("GISDBASE")
#
# list of locations/mapsets
#
self.listOfLocations = []
self.listOfMapsets = []
self.listOfMapsetsSelectable = []
wx.Frame.__init__(self, parent=parent, id=id, style=style)
self.locale = wx.Locale(language=wx.LANGUAGE_DEFAULT)
# scroll panel was used here but not properly and is probably not need
# as long as it is not high too much
self.panel = wx.Panel(parent=self, id=wx.ID_ANY)
# i18N
#
# graphical elements
#
# image
try:
if os.getenv('ISISROOT'):
name = os.path.join(globalvar.GUIDIR, "images",
"startup_banner_isis.png")
else:
name = os.path.join(globalvar.GUIDIR, "images",
"startup_banner.png")
self.hbitmap = wx.StaticBitmap(
self.panel, wx.ID_ANY,
wx.Bitmap(name=name, type=wx.BITMAP_TYPE_PNG))
except:
self.hbitmap = wx.StaticBitmap(
self.panel, wx.ID_ANY, BitmapFromImage(wx.EmptyImage(530,
150)))
# labels
# crashes when LOCATION doesn't exist
# get version & revision
grassVersion, grassRevisionStr = sgui.GetVersion()
self.gisdbase_box = StaticBox(
parent=self.panel,
id=wx.ID_ANY,
label=" %s " % _("1. Select GRASS GIS database directory"))
self.location_box = StaticBox(parent=self.panel,
id=wx.ID_ANY,
label=" %s " %
_("2. Select GRASS Location"))
self.mapset_box = StaticBox(parent=self.panel,
id=wx.ID_ANY,
label=" %s " % _("3. Select GRASS Mapset"))
self.lmessage = StaticText(parent=self.panel)
# It is not clear if all wx versions supports color, so try-except.
# The color itself may not be correct for all platforms/system settings
# but in http://xoomer.virgilio.it/infinity77/wxPython/Widgets/wx.SystemSettings.html
# there is no 'warning' color.
try:
self.lmessage.SetForegroundColour(wx.Colour(255, 0, 0))
except AttributeError:
pass
self.gisdbase_panel = wx.Panel(parent=self.panel)
self.location_panel = wx.Panel(parent=self.panel)
self.mapset_panel = wx.Panel(parent=self.panel)
self.ldbase = StaticText(
parent=self.gisdbase_panel,
id=wx.ID_ANY,
label=_("GRASS GIS database directory contains Locations."))
self.llocation = StaticWrapText(
parent=self.location_panel,
id=wx.ID_ANY,
label=_("All data in one Location is in the same "
" coordinate reference system (projection)."
" One Location can be one project."
" Location contains Mapsets."),
style=wx.ALIGN_LEFT)
self.lmapset = StaticWrapText(
parent=self.mapset_panel,
id=wx.ID_ANY,
label=_("Mapset contains GIS data related"
" to one project, task within one project,"
" subregion or user."),
style=wx.ALIGN_LEFT)
try:
for label in [self.ldbase, self.llocation, self.lmapset]:
label.SetForegroundColour(
wx.SystemSettings.GetColour(wx.SYS_COLOUR_GRAYTEXT))
except AttributeError:
# for explanation of try-except see above
pass
# buttons
self.bstart = Button(parent=self.panel,
id=wx.ID_ANY,
label=_("Start &GRASS session"))
self.bstart.SetDefault()
self.bexit = Button(parent=self.panel, id=wx.ID_EXIT)
self.bstart.SetMinSize((180, self.bexit.GetSize()[1]))
self.bhelp = Button(parent=self.panel, id=wx.ID_HELP)
self.bbrowse = Button(parent=self.gisdbase_panel,
id=wx.ID_ANY,
label=_("&Browse"))
self.bmapset = Button(
parent=self.mapset_panel,
id=wx.ID_ANY,
# GTC New mapset
label=_("&New"))
self.bmapset.SetToolTip(_("Create a new Mapset in selected Location"))
self.bwizard = Button(
parent=self.location_panel,
id=wx.ID_ANY,
# GTC New location
label=_("N&ew"))
self.bwizard.SetToolTip(
_("Create a new location using location wizard."
" After location is created successfully,"
" GRASS session is started."))
self.rename_location_button = Button(
parent=self.location_panel,
id=wx.ID_ANY,
# GTC Rename location
label=_("Ren&ame"))
self.rename_location_button.SetToolTip(_("Rename selected location"))
self.delete_location_button = Button(
parent=self.location_panel,
id=wx.ID_ANY,
# GTC Delete location
label=_("De&lete"))
self.delete_location_button.SetToolTip(_("Delete selected location"))
self.download_location_button = Button(parent=self.location_panel,
id=wx.ID_ANY,
label=_("Do&wnload"))
self.download_location_button.SetToolTip(_("Download sample location"))
self.rename_mapset_button = Button(
parent=self.mapset_panel,
id=wx.ID_ANY,
# GTC Rename mapset
label=_("&Rename"))
self.rename_mapset_button.SetToolTip(_("Rename selected mapset"))
self.delete_mapset_button = Button(
parent=self.mapset_panel,
id=wx.ID_ANY,
# GTC Delete mapset
label=_("&Delete"))
self.delete_mapset_button.SetToolTip(_("Delete selected mapset"))
# textinputs
self.tgisdbase = TextCtrl(parent=self.gisdbase_panel,
id=wx.ID_ANY,
value="",
size=(300, -1),
style=wx.TE_PROCESS_ENTER)
# Locations
self.lblocations = GListBox(parent=self.location_panel,
id=wx.ID_ANY,
size=(180, 200),
choices=self.listOfLocations)
self.lblocations.SetColumnWidth(0, 180)
# TODO: sort; but keep PERMANENT on top of list
# Mapsets
self.lbmapsets = GListBox(parent=self.mapset_panel,
id=wx.ID_ANY,
size=(180, 200),
choices=self.listOfMapsets)
self.lbmapsets.SetColumnWidth(0, 180)
# layout & properties, first do layout so everything is created
self._do_layout()
self._set_properties(grassVersion, grassRevisionStr)
# events
self.bbrowse.Bind(wx.EVT_BUTTON, self.OnBrowse)
self.bstart.Bind(wx.EVT_BUTTON, self.OnStart)
self.bexit.Bind(wx.EVT_BUTTON, self.OnExit)
self.bhelp.Bind(wx.EVT_BUTTON, self.OnHelp)
self.bmapset.Bind(wx.EVT_BUTTON, self.OnCreateMapset)
self.bwizard.Bind(wx.EVT_BUTTON, self.OnWizard)
self.rename_location_button.Bind(wx.EVT_BUTTON, self.RenameLocation)
self.delete_location_button.Bind(wx.EVT_BUTTON, self.DeleteLocation)
self.download_location_button.Bind(wx.EVT_BUTTON,
self.DownloadLocation)
self.rename_mapset_button.Bind(wx.EVT_BUTTON, self.RenameMapset)
self.delete_mapset_button.Bind(wx.EVT_BUTTON, self.DeleteMapset)
self.lblocations.Bind(wx.EVT_LIST_ITEM_SELECTED, self.OnSelectLocation)
self.lbmapsets.Bind(wx.EVT_LIST_ITEM_SELECTED, self.OnSelectMapset)
self.lbmapsets.Bind(wx.EVT_LIST_ITEM_ACTIVATED, self.OnStart)
self.tgisdbase.Bind(wx.EVT_TEXT_ENTER, self.OnSetDatabase)
self.Bind(wx.EVT_CLOSE, self.OnCloseWindow)
def _set_properties(self, version, revision):
"""Set frame properties
:param version: Version in the form of X.Y.Z
:param revision: Version control revision with leading space
*revision* should be an empty string in case of release and
otherwise it needs a leading space to be separated from the rest
of the title.
"""
self.SetTitle(_("GRASS GIS %s Startup%s") % (version, revision))
self.SetIcon(
wx.Icon(os.path.join(globalvar.ICONDIR, "grass.ico"),
wx.BITMAP_TYPE_ICO))
self.bstart.SetForegroundColour(wx.Colour(35, 142, 35))
self.bstart.SetToolTip(_("Enter GRASS session"))
self.bstart.Enable(False)
self.bmapset.Enable(False)
# this all was originally a choice, perhaps just mapset needed
self.rename_location_button.Enable(False)
self.delete_location_button.Enable(False)
self.rename_mapset_button.Enable(False)
self.delete_mapset_button.Enable(False)
# set database
if not self.gisdbase:
# sets an initial path for gisdbase if nothing in GISRC
if os.path.isdir(os.getenv("HOME")):
self.gisdbase = os.getenv("HOME")
else:
self.gisdbase = os.getcwd()
try:
self.tgisdbase.SetValue(self.gisdbase)
except UnicodeDecodeError:
wx.MessageBox(parent=self,
caption=_("Error"),
message=_("Unable to set GRASS database. "
"Check your locale settings."),
style=wx.OK | wx.ICON_ERROR | wx.CENTRE)
self.OnSetDatabase(None)
location = self.GetRCValue("LOCATION_NAME")
if location == "<UNKNOWN>" or location is None:
return
if not os.path.isdir(os.path.join(self.gisdbase, location)):
location = None
# list of locations
self.UpdateLocations(self.gisdbase)
try:
self.lblocations.SetSelection(self.listOfLocations.index(location),
force=True)
self.lblocations.EnsureVisible(
self.listOfLocations.index(location))
except ValueError:
sys.stderr.write(
_("ERROR: Location <%s> not found\n") %
self.GetRCValue("LOCATION_NAME"))
if len(self.listOfLocations) > 0:
self.lblocations.SetSelection(0, force=True)
self.lblocations.EnsureVisible(0)
location = self.listOfLocations[0]
else:
return
# list of mapsets
self.UpdateMapsets(os.path.join(self.gisdbase, location))
mapset = self.GetRCValue("MAPSET")
if mapset:
try:
self.lbmapsets.SetSelection(self.listOfMapsets.index(mapset),
force=True)
self.lbmapsets.EnsureVisible(self.listOfMapsets.index(mapset))
except ValueError:
sys.stderr.write(_("ERROR: Mapset <%s> not found\n") % mapset)
self.lbmapsets.SetSelection(0, force=True)
self.lbmapsets.EnsureVisible(0)
def _do_layout(self):
sizer = wx.BoxSizer(wx.VERTICAL)
self.sizer = sizer # for the layout call after changing message
dbase_sizer = wx.BoxSizer(wx.HORIZONTAL)
location_mapset_sizer = wx.BoxSizer(wx.HORIZONTAL)
gisdbase_panel_sizer = wx.BoxSizer(wx.VERTICAL)
gisdbase_boxsizer = wx.StaticBoxSizer(self.gisdbase_box, wx.VERTICAL)
btns_sizer = wx.BoxSizer(wx.HORIZONTAL)
self.gisdbase_panel.SetSizer(gisdbase_panel_sizer)
# gis data directory
gisdbase_boxsizer.Add(self.gisdbase_panel,
proportion=1,
flag=wx.EXPAND | wx.ALL,
border=1)
gisdbase_panel_sizer.Add(dbase_sizer,
proportion=1,
flag=wx.EXPAND | wx.ALL,
border=1)
gisdbase_panel_sizer.Add(self.ldbase,
proportion=0,
flag=wx.EXPAND | wx.ALL,
border=1)
dbase_sizer.Add(self.tgisdbase,
proportion=1,
flag=wx.ALIGN_CENTER_VERTICAL | wx.ALL,
border=1)
dbase_sizer.Add(self.bbrowse,
proportion=0,
flag=wx.ALIGN_CENTER_VERTICAL | wx.ALL,
border=1)
gisdbase_panel_sizer.Fit(self.gisdbase_panel)
# location and mapset lists
def layout_list_box(box, panel, list_box, buttons, description):
panel_sizer = wx.BoxSizer(wx.VERTICAL)
main_sizer = wx.BoxSizer(wx.HORIZONTAL)
box_sizer = wx.StaticBoxSizer(box, wx.VERTICAL)
buttons_sizer = wx.BoxSizer(wx.VERTICAL)
panel.SetSizer(panel_sizer)
panel_sizer.Fit(panel)
main_sizer.Add(list_box,
proportion=1,
flag=wx.EXPAND | wx.ALL,
border=1)
main_sizer.Add(buttons_sizer,
proportion=0,
flag=wx.ALIGN_CENTER_HORIZONTAL | wx.ALL,
border=1)
for button in buttons:
buttons_sizer.Add(button,
proportion=0,
flag=wx.EXPAND | wx.LEFT | wx.RIGHT
| wx.BOTTOM,
border=3)
box_sizer.Add(panel,
proportion=1,
flag=wx.EXPAND | wx.ALL,
border=1)
panel_sizer.Add(main_sizer,
proportion=1,
flag=wx.EXPAND | wx.ALL,
border=1)
panel_sizer.Add(description,
proportion=0,
flag=wx.EXPAND | wx.ALL,
border=1)
return box_sizer
location_boxsizer = layout_list_box(box=self.location_box,
panel=self.location_panel,
list_box=self.lblocations,
buttons=[
self.bwizard,
self.rename_location_button,
self.delete_location_button,
self.download_location_button
],
description=self.llocation)
mapset_boxsizer = layout_list_box(box=self.mapset_box,
panel=self.mapset_panel,
list_box=self.lbmapsets,
buttons=[
self.bmapset,
self.rename_mapset_button,
self.delete_mapset_button
],
description=self.lmapset)
# location and mapset sizer
location_mapset_sizer.Add(location_boxsizer,
proportion=1,
flag=wx.LEFT | wx.RIGHT | wx.EXPAND,
border=3)
location_mapset_sizer.Add(mapset_boxsizer,
proportion=1,
flag=wx.RIGHT | wx.EXPAND,
border=3)
# buttons
btns_sizer.Add(self.bstart,
proportion=0,
flag=wx.ALIGN_CENTER_HORIZONTAL
| wx.ALIGN_CENTER_VERTICAL | wx.ALL,
border=5)
btns_sizer.Add(self.bexit,
proportion=0,
flag=wx.ALIGN_CENTER_HORIZONTAL
| wx.ALIGN_CENTER_VERTICAL | wx.ALL,
border=5)
btns_sizer.Add(self.bhelp,
proportion=0,
flag=wx.ALIGN_CENTER_HORIZONTAL
| wx.ALIGN_CENTER_VERTICAL | wx.ALL,
border=5)
# main sizer
sizer.Add(self.hbitmap,
proportion=0,
flag=wx.ALIGN_CENTER_VERTICAL | wx.ALIGN_CENTER_HORIZONTAL
| wx.ALL,
border=3) # image
sizer.Add(gisdbase_boxsizer,
proportion=0,
flag=wx.ALIGN_CENTER_HORIZONTAL | wx.RIGHT | wx.LEFT | wx.TOP
| wx.EXPAND,
border=3) # GISDBASE setting
# warning/error message
sizer.Add(self.lmessage,
proportion=0,
flag=wx.ALIGN_CENTER_VERTICAL | wx.ALIGN_LEFT | wx.ALL
| wx.EXPAND,
border=5)
sizer.Add(location_mapset_sizer,
proportion=1,
flag=wx.RIGHT | wx.LEFT | wx.EXPAND,
border=1)
sizer.Add(btns_sizer,
proportion=0,
flag=wx.ALIGN_CENTER_VERTICAL | wx.ALIGN_CENTER_HORIZONTAL
| wx.RIGHT | wx.LEFT,
border=3)
self.panel.SetAutoLayout(True)
self.panel.SetSizer(sizer)
sizer.Fit(self.panel)
sizer.SetSizeHints(self)
self.Layout()
def _showWarning(self, text):
"""Displays a warning, hint or info message to the user.
This function can be used for all kinds of messages except for
error messages.
.. note::
There is no cleaning procedure. You should call _hideMessage when
you know that there is everything correct now.
"""
self.lmessage.SetLabel(text)
self.lmessage.Wrap(self.GetClientSize()[0])
self.sizer.Layout()
def _showError(self, text):
"""Displays a error message to the user.
This function should be used only when something serious and unexpected
happens, otherwise _showWarning should be used.
.. note::
There is no cleaning procedure. You should call _hideMessage when
you know that there is everything correct now.
"""
self.lmessage.SetLabel(_("Error: {text}").format(text=text))
self.lmessage.Wrap(self.GetClientSize()[0])
self.sizer.Layout()
def _hideMessage(self):
"""Clears/hides the error message."""
# we do no hide widget
# because we do not want the dialog to change the size
self.lmessage.SetLabel("")
self.sizer.Layout()
def GetRCValue(self, value):
"""Return GRASS variable (read from GISRC)
"""
if value in self.grassrc:
return self.grassrc[value]
else:
return None
def SuggestDatabase(self):
"""Suggest (set) possible GRASS Database value"""
# only if nothing is set (<UNKNOWN> comes from init script)
if self.GetRCValue("LOCATION_NAME") != "<UNKNOWN>":
return
path = get_possible_database_path()
if path:
try:
self.tgisdbase.SetValue(path)
except UnicodeDecodeError:
# restore previous state
# wizard gives error in this case, we just ignore
path = None
self.tgisdbase.SetValue(self.gisdbase)
# if we still have path
if path:
self.gisdbase = path
self.OnSetDatabase(None)
else:
# nothing found
# TODO: should it be warning, hint or message?
self._showWarning(
_('GRASS needs a directory (GRASS database) '
'in which to store its data. '
'Create one now if you have not already done so. '
'A popular choice is "grassdata", located in '
'your home directory. '
'Press Browse button to select the directory.'))
def OnWizard(self, event):
"""Location wizard started"""
from location_wizard.wizard import LocationWizard
gWizard = LocationWizard(parent=self,
grassdatabase=self.tgisdbase.GetValue())
if gWizard.location is not None:
self.tgisdbase.SetValue(gWizard.grassdatabase)
self.OnSetDatabase(None)
self.UpdateMapsets(os.path.join(self.gisdbase, gWizard.location))
self.lblocations.SetSelection(
self.listOfLocations.index(gWizard.location))
self.lbmapsets.SetSelection(0)
self.SetLocation(self.gisdbase, gWizard.location, 'PERMANENT')
if gWizard.georeffile:
message = _(
"Do you want to import <%(name)s> to the newly created location?"
) % {
'name': gWizard.georeffile
}
dlg = wx.MessageDialog(parent=self,
message=message,
caption=_("Import data?"),
style=wx.YES_NO | wx.YES_DEFAULT
| wx.ICON_QUESTION)
dlg.CenterOnParent()
if dlg.ShowModal() == wx.ID_YES:
self.ImportFile(gWizard.georeffile)
dlg.Destroy()
if gWizard.default_region:
defineRegion = RegionDef(self, location=gWizard.location)
defineRegion.CenterOnParent()
defineRegion.ShowModal()
defineRegion.Destroy()
if gWizard.user_mapset:
self.OnCreateMapset(event)
def ImportFile(self, filePath):
"""Tries to import file as vector or raster.
If successfull sets default region from imported map.
"""
RunCommand('db.connect', flags='c')
mapName = os.path.splitext(os.path.basename(filePath))[0]
vectors = RunCommand('v.in.ogr', input=filePath, flags='l', read=True)
wx.BeginBusyCursor()
wx.GetApp().Yield()
if vectors:
# vector detected
returncode, error = RunCommand('v.in.ogr',
input=filePath,
output=mapName,
flags='e',
getErrorMsg=True)
else:
returncode, error = RunCommand('r.in.gdal',
input=filePath,
output=mapName,
flags='e',
getErrorMsg=True)
wx.EndBusyCursor()
if returncode != 0:
GError(parent=self,
message=_("Import of <%(name)s> failed.\n"
"Reason: %(msg)s") % ({
'name': filePath,
'msg': error
}))
else:
GMessage(message=_(
"Data file <%(name)s> imported successfully. "
"The location's default region was set from this imported map."
) % {'name': filePath},
parent=self)
# the event can be refactored out by using lambda in bind
def RenameMapset(self, event):
"""Rename selected mapset
"""
location = self.listOfLocations[self.lblocations.GetSelection()]
mapset = self.listOfMapsets[self.lbmapsets.GetSelection()]
if mapset == 'PERMANENT':
GMessage(
parent=self,
message=_(
'Mapset <PERMANENT> is required for valid GRASS location.\n\n'
'This mapset cannot be renamed.'))
return
dlg = TextEntryDialog(
parent=self,
message=_('Current name: %s\n\nEnter new name:') % mapset,
caption=_('Rename selected mapset'),
validator=GenericValidator(grass.legal_name,
self._nameValidationFailed))
if dlg.ShowModal() == wx.ID_OK:
newmapset = dlg.GetValue()
if newmapset == mapset:
dlg.Destroy()
return
if newmapset in self.listOfMapsets:
wx.MessageBox(
parent=self,
caption=_('Message'),
message=_('Unable to rename mapset.\n\n'
'Mapset <%s> already exists in location.') %
newmapset,
style=wx.OK | wx.ICON_INFORMATION | wx.CENTRE)
else:
try:
sutils.rename_mapset(self.gisdbase, location, mapset,
newmapset)
self.OnSelectLocation(None)
self.lbmapsets.SetSelection(
self.listOfMapsets.index(newmapset))
except Exception as e:
wx.MessageBox(parent=self,
caption=_('Error'),
message=_('Unable to rename mapset.\n\n%s') %
e,
style=wx.OK | wx.ICON_ERROR | wx.CENTRE)
dlg.Destroy()
def RenameLocation(self, event):
"""Rename selected location
"""
location = self.listOfLocations[self.lblocations.GetSelection()]
dlg = TextEntryDialog(
parent=self,
message=_('Current name: %s\n\nEnter new name:') % location,
caption=_('Rename selected location'),
validator=GenericValidator(grass.legal_name,
self._nameValidationFailed))
if dlg.ShowModal() == wx.ID_OK:
newlocation = dlg.GetValue()
if newlocation == location:
dlg.Destroy()
return
if newlocation in self.listOfLocations:
wx.MessageBox(
parent=self,
caption=_('Message'),
message=_(
'Unable to rename location.\n\n'
'Location <%s> already exists in GRASS database.') %
newlocation,
style=wx.OK | wx.ICON_INFORMATION | wx.CENTRE)
else:
try:
sutils.rename_location(self.gisdbase, location,
newlocation)
self.UpdateLocations(self.gisdbase)
self.lblocations.SetSelection(
self.listOfLocations.index(newlocation))
self.UpdateMapsets(newlocation)
except Exception as e:
wx.MessageBox(
parent=self,
caption=_('Error'),
message=_('Unable to rename location.\n\n%s') % e,
style=wx.OK | wx.ICON_ERROR | wx.CENTRE)
dlg.Destroy()
def DeleteMapset(self, event):
"""Delete selected mapset
"""
location = self.listOfLocations[self.lblocations.GetSelection()]
mapset = self.listOfMapsets[self.lbmapsets.GetSelection()]
if mapset == 'PERMANENT':
GMessage(
parent=self,
message=_(
'Mapset <PERMANENT> is required for valid GRASS location.\n\n'
'This mapset cannot be deleted.'))
return
dlg = wx.MessageDialog(
parent=self,
message=_(
"Do you want to continue with deleting mapset <%(mapset)s> "
"from location <%(location)s>?\n\n"
"ALL MAPS included in this mapset will be "
"PERMANENTLY DELETED!") % {
'mapset': mapset,
'location': location
},
caption=_("Delete selected mapset"),
style=wx.YES_NO | wx.NO_DEFAULT | wx.ICON_QUESTION)
if dlg.ShowModal() == wx.ID_YES:
try:
sutils.delete_mapset(self.gisdbase, location, mapset)
self.OnSelectLocation(None)
self.lbmapsets.SetSelection(0)
except:
wx.MessageBox(message=_('Unable to delete mapset'))
dlg.Destroy()
def DeleteLocation(self, event):
"""
Delete selected location
"""
location = self.listOfLocations[self.lblocations.GetSelection()]
dlg = wx.MessageDialog(
parent=self,
message=_("Do you want to continue with deleting "
"location <%s>?\n\n"
"ALL MAPS included in this location will be "
"PERMANENTLY DELETED!") % (location),
caption=_("Delete selected location"),
style=wx.YES_NO | wx.NO_DEFAULT | wx.ICON_QUESTION)
if dlg.ShowModal() == wx.ID_YES:
try:
sutils.delete_location(self.gisdbase, location)
self.UpdateLocations(self.gisdbase)
self.lblocations.SetSelection(0)
self.OnSelectLocation(None)
self.lbmapsets.SetSelection(0)
except:
wx.MessageBox(message=_('Unable to delete location'))
dlg.Destroy()
def DownloadLocation(self, event):
"""Download location online"""
from startup.locdownload import LocationDownloadDialog
loc_download = LocationDownloadDialog(parent=self,
database=self.gisdbase)
loc_download.ShowModal()
location = loc_download.GetLocation()
if location:
# get the new location to the list
self.UpdateLocations(self.gisdbase)
# seems to be used in similar context
self.UpdateMapsets(os.path.join(self.gisdbase, location))
self.lblocations.SetSelection(self.listOfLocations.index(location))
# wizard does this as well, not sure if needed
self.SetLocation(self.gisdbase, location, 'PERMANENT')
# seems to be used in similar context
self.OnSelectLocation(None)
loc_download.Destroy()
def UpdateLocations(self, dbase):
"""Update list of locations"""
try:
self.listOfLocations = GetListOfLocations(dbase)
except (UnicodeEncodeError, UnicodeDecodeError) as e:
GError(parent=self,
message=_(
"Unicode error detected. "
"Check your locale settings. Details: {0}").format(e),
showTraceback=False)
self.lblocations.Clear()
self.lblocations.InsertItems(self.listOfLocations, 0)
if len(self.listOfLocations) > 0:
self._hideMessage()
self.lblocations.SetSelection(0)
else:
self.lblocations.SetSelection(wx.NOT_FOUND)
self._showWarning(
_("No GRASS Location found in '%s'."
" Create a new Location or choose different"
" GRASS database directory.") % self.gisdbase)
return self.listOfLocations
def UpdateMapsets(self, location):
"""Update list of mapsets"""
self.FormerMapsetSelection = wx.NOT_FOUND # for non-selectable item
self.listOfMapsetsSelectable = list()
self.listOfMapsets = GetListOfMapsets(self.gisdbase, location)
self.lbmapsets.Clear()
# disable mapset with denied permission
locationName = os.path.basename(location)
ret = RunCommand('g.mapset',
read=True,
flags='l',
location=locationName,
gisdbase=self.gisdbase)
if ret:
for line in ret.splitlines():
self.listOfMapsetsSelectable += line.split(' ')
else:
self.SetLocation(self.gisdbase, locationName, "PERMANENT")
# first run only
self.listOfMapsetsSelectable = copy.copy(self.listOfMapsets)
disabled = []
idx = 0
for mapset in self.listOfMapsets:
if mapset not in self.listOfMapsetsSelectable or \
get_lockfile_if_present(self.gisdbase,
locationName, mapset):
disabled.append(idx)
idx += 1
self.lbmapsets.InsertItems(self.listOfMapsets, 0, disabled=disabled)
return self.listOfMapsets
def OnSelectLocation(self, event):
"""Location selected"""
if event:
self.lblocations.SetSelection(event.GetIndex())
if self.lblocations.GetSelection() != wx.NOT_FOUND:
self.UpdateMapsets(
os.path.join(
self.gisdbase,
self.listOfLocations[self.lblocations.GetSelection()]))
else:
self.listOfMapsets = []
disabled = []
idx = 0
try:
locationName = self.listOfLocations[
self.lblocations.GetSelection()]
except IndexError:
locationName = ''
for mapset in self.listOfMapsets:
if mapset not in self.listOfMapsetsSelectable or \
get_lockfile_if_present(self.gisdbase,
locationName, mapset):
disabled.append(idx)
idx += 1
self.lbmapsets.Clear()
self.lbmapsets.InsertItems(self.listOfMapsets, 0, disabled=disabled)
if len(self.listOfMapsets) > 0:
self.lbmapsets.SetSelection(0)
if locationName:
# enable start button when location and mapset is selected
self.bstart.Enable()
self.bstart.SetFocus()
self.bmapset.Enable()
# replacing disabled choice, perhaps just mapset needed
self.rename_location_button.Enable()
self.delete_location_button.Enable()
self.rename_mapset_button.Enable()
self.delete_mapset_button.Enable()
else:
self.lbmapsets.SetSelection(wx.NOT_FOUND)
self.bstart.Enable(False)
self.bmapset.Enable(False)
# this all was originally a choice, perhaps just mapset needed
self.rename_location_button.Enable(False)
self.delete_location_button.Enable(False)
self.rename_mapset_button.Enable(False)
self.delete_mapset_button.Enable(False)
def OnSelectMapset(self, event):
"""Mapset selected"""
self.lbmapsets.SetSelection(event.GetIndex())
if event.GetText() not in self.listOfMapsetsSelectable:
self.lbmapsets.SetSelection(self.FormerMapsetSelection)
else:
self.FormerMapsetSelection = event.GetIndex()
event.Skip()
def OnSetDatabase(self, event):
"""Database set"""
gisdbase = self.tgisdbase.GetValue()
self._hideMessage()
if not os.path.exists(gisdbase):
self._showError(_("Path '%s' doesn't exist.") % gisdbase)
return
self.gisdbase = self.tgisdbase.GetValue()
self.UpdateLocations(self.gisdbase)
self.OnSelectLocation(None)
def OnBrowse(self, event):
"""'Browse' button clicked"""
if not event:
defaultPath = os.getenv('HOME')
else:
defaultPath = ""
dlg = wx.DirDialog(parent=self,
message=_("Choose GIS Data Directory"),
defaultPath=defaultPath,
style=wx.DD_DEFAULT_STYLE)
if dlg.ShowModal() == wx.ID_OK:
self.gisdbase = dlg.GetPath()
self.tgisdbase.SetValue(self.gisdbase)
self.OnSetDatabase(event)
dlg.Destroy()
def OnCreateMapset(self, event):
"""Create new mapset"""
dlg = NewMapsetDialog(
parent=self,
default=self._getDefaultMapsetName(),
validation_failed_handler=self._nameValidationFailed,
help_hanlder=self.OnHelp,
)
if dlg.ShowModal() == wx.ID_OK:
mapset = dlg.GetValue()
return self.CreateNewMapset(mapset=mapset)
else:
return False
def CreateNewMapset(self, mapset):
if mapset in self.listOfMapsets:
GMessage(parent=self,
message=_("Mapset <%s> already exists.") % mapset)
return False
if mapset.lower() == 'ogr':
dlg1 = wx.MessageDialog(
parent=self,
message=_(
"Mapset <%s> is reserved for direct "
"read access to OGR layers. Please consider to use "
"another name for your mapset.\n\n"
"Are you really sure that you want to create this mapset?")
% mapset,
caption=_("Reserved mapset name"),
style=wx.YES_NO | wx.NO_DEFAULT | wx.ICON_QUESTION)
ret = dlg1.ShowModal()
dlg1.Destroy()
if ret == wx.ID_NO:
dlg1.Destroy()
return False
try:
self.gisdbase = self.tgisdbase.GetValue()
location = self.listOfLocations[self.lblocations.GetSelection()]
create_mapset(self.gisdbase, location, mapset)
self.OnSelectLocation(None)
self.lbmapsets.SetSelection(self.listOfMapsets.index(mapset))
self.bstart.SetFocus()
return True
except Exception as e:
GError(parent=self,
message=_("Unable to create new mapset: %s") % e,
showTraceback=False)
return False
def OnStart(self, event):
"""'Start GRASS' button clicked"""
dbase = self.tgisdbase.GetValue()
location = self.listOfLocations[self.lblocations.GetSelection()]
mapset = self.listOfMapsets[self.lbmapsets.GetSelection()]
lockfile = get_lockfile_if_present(dbase, location, mapset)
if lockfile:
dlg = wx.MessageDialog(
parent=self,
message=_(
"GRASS is already running in selected mapset <%(mapset)s>\n"
"(file %(lock)s found).\n\n"
"Concurrent use not allowed.\n\n"
"Do you want to try to remove .gislock (note that you "
"need permission for this operation) and continue?") % {
'mapset': mapset,
'lock': lockfile
},
caption=_("Lock file found"),
style=wx.YES_NO | wx.NO_DEFAULT | wx.ICON_QUESTION | wx.CENTRE)
ret = dlg.ShowModal()
dlg.Destroy()
if ret == wx.ID_YES:
dlg1 = wx.MessageDialog(
parent=self,
message=
_("ARE YOU REALLY SURE?\n\n"
"If you really are running another GRASS session doing this "
"could corrupt your data. Have another look in the processor "
"manager just to be sure..."),
caption=_("Lock file found"),
style=wx.YES_NO | wx.NO_DEFAULT | wx.ICON_QUESTION
| wx.CENTRE)
ret = dlg1.ShowModal()
dlg1.Destroy()
if ret == wx.ID_YES:
try:
os.remove(lockfile)
except IOError as e:
GError(
_("Unable to remove '%(lock)s'.\n\n"
"Details: %(reason)s") % {
'lock': lockfile,
'reason': e
})
else:
return
else:
return
self.SetLocation(dbase, location, mapset)
self.ExitSuccessfully()
def SetLocation(self, dbase, location, mapset):
SetSessionMapset(dbase, location, mapset)
def _getDefaultMapsetName(self):
"""Returns default name for mapset."""
try:
defaultName = getpass.getuser()
# raise error if not ascii (not valid mapset name)
defaultName.encode('ascii')
except: # whatever might go wrong
defaultName = 'user'
return defaultName
def ExitSuccessfully(self):
self.Destroy()
sys.exit(self.exit_success)
def OnExit(self, event):
"""'Exit' button clicked"""
self.Destroy()
sys.exit(self.exit_user_requested)
def OnHelp(self, event):
"""'Help' button clicked"""
# help text in lib/init/helptext.html
RunCommand('g.manual', entry='helptext')
def OnCloseWindow(self, event):
"""Close window event"""
event.Skip()
sys.exit(self.exit_user_requested)
def _nameValidationFailed(self, ctrl):
message = _(
"Name <%(name)s> is not a valid name for location or mapset. "
"Please use only ASCII characters excluding %(chars)s "
"and space.") % {
'name': ctrl.GetValue(),
'chars': '/"\'@,=*~'
}
GError(parent=self, message=message, caption=_("Invalid name"))
def _pageInfo(self):
"""Info page"""
# get version and web site
vInfo = grass.version()
if not vInfo:
sys.stderr.write(_("Unable to get GRASS version\n"))
infoTxt = ScrolledPanel(self.aboutNotebook)
infoTxt.SetBackgroundColour('WHITE')
infoTxt.SetupScrolling()
infoSizer = wx.BoxSizer(wx.VERTICAL)
infoGridSizer = wx.GridBagSizer(vgap=5, hgap=5)
logo = os.path.join(globalvar.ICONDIR, "grass-64x64.png")
logoBitmap = wx.StaticBitmap(
infoTxt, wx.ID_ANY, wx.Bitmap(name=logo, type=wx.BITMAP_TYPE_PNG))
infoSizer.Add(logoBitmap,
proportion=0,
flag=wx.ALL | wx.ALIGN_CENTER,
border=20)
infoLabel = 'GRASS GIS %s' % vInfo.get('version', _('unknown version'))
if 'x86_64' in vInfo.get('build_platform', ''):
infoLabel += ' (64bit)'
info = StaticText(parent=infoTxt,
id=wx.ID_ANY,
label=infoLabel + os.linesep)
info.SetFont(wx.Font(13, wx.DEFAULT, wx.NORMAL, wx.BOLD, 0, ""))
info.SetForegroundColour(wx.Colour(35, 142, 35))
infoSizer.Add(info,
proportion=0,
flag=wx.BOTTOM | wx.ALIGN_CENTER,
border=1)
team = StaticText(parent=infoTxt, label=_grassDevTeam(1999) + '\n')
infoSizer.Add(team,
proportion=0,
flag=wx.BOTTOM | wx.ALIGN_CENTER,
border=1)
row = 0
infoGridSizer.Add(StaticText(parent=infoTxt,
id=wx.ID_ANY,
label=_('Official GRASS site:')),
pos=(row, 0),
flag=wx.ALIGN_RIGHT)
infoGridSizer.Add(HyperLinkCtrl(parent=infoTxt,
id=wx.ID_ANY,
label='https://grass.osgeo.org'),
pos=(row, 1),
flag=wx.ALIGN_LEFT)
row += 2
infoGridSizer.Add(StaticText(parent=infoTxt,
id=wx.ID_ANY,
label='%s:' % _('Code Revision')),
pos=(row, 0),
flag=wx.ALIGN_RIGHT)
infoGridSizer.Add(HyperLinkCtrl(
parent=infoTxt,
id=wx.ID_ANY,
label=vInfo.get('revision', '?'),
URL='https://github.com/OSGeo/grass.git'),
pos=(row, 1),
flag=wx.ALIGN_LEFT)
row += 1
infoGridSizer.Add(StaticText(parent=infoTxt,
id=wx.ID_ANY,
label='%s:' % _('Build Date')),
pos=(row, 0),
flag=wx.ALIGN_RIGHT)
infoGridSizer.Add(StaticText(parent=infoTxt,
id=wx.ID_ANY,
label=vInfo.get('build_date', '?')),
pos=(row, 1),
flag=wx.ALIGN_LEFT)
# show only basic info
# row += 1
# infoGridSizer.Add(item = wx.StaticText(parent = infoTxt, id = wx.ID_ANY,
# label = '%s:' % _('GIS Library Revision')),
# pos = (row, 0),
# flag = wx.ALIGN_RIGHT)
# infoGridSizer.Add(item = wx.StaticText(parent = infoTxt, id = wx.ID_ANY,
# label = vInfo['libgis_revision'] + ' (' +
# vInfo['libgis_date'].split(' ')[0] + ')'),
# pos = (row, 1),
# flag = wx.ALIGN_LEFT)
row += 2
infoGridSizer.Add(StaticText(parent=infoTxt,
id=wx.ID_ANY,
label='Python:'),
pos=(row, 0),
flag=wx.ALIGN_RIGHT)
infoGridSizer.Add(StaticText(parent=infoTxt,
id=wx.ID_ANY,
label=platform.python_version()),
pos=(row, 1),
flag=wx.ALIGN_LEFT)
row += 1
infoGridSizer.Add(StaticText(parent=infoTxt,
id=wx.ID_ANY,
label='wxPython:'),
pos=(row, 0),
flag=wx.ALIGN_RIGHT)
infoGridSizer.Add(StaticText(parent=infoTxt,
id=wx.ID_ANY,
label=wx.__version__),
pos=(row, 1),
flag=wx.ALIGN_LEFT)
infoGridSizer.AddGrowableCol(0)
infoGridSizer.AddGrowableCol(1)
infoSizer.Add(infoGridSizer, proportion=1, flag=wx.EXPAND)
row += 2
infoGridSizer.Add(StaticText(parent=infoTxt,
id=wx.ID_ANY,
label="%s:" % _('Language')),
pos=(row, 0),
flag=wx.ALIGN_RIGHT)
self.langUsed = grass.gisenv().get('LANG', None)
if not self.langUsed:
import locale
loc = locale.getdefaultlocale()
if loc == (None, None):
self.langUsed = _('unknown')
else:
self.langUsed = u'%s.%s' % (loc[0], loc[1])
infoGridSizer.Add(StaticText(parent=infoTxt,
id=wx.ID_ANY,
label=self.langUsed),
pos=(row, 1),
flag=wx.ALIGN_LEFT)
infoTxt.SetSizer(infoSizer)
infoSizer.Fit(infoTxt)
return infoTxt
class SearchModuleWindow(wx.Panel):
"""Menu tree and search widget for searching modules.
Signal:
showNotification - attribute 'message'
"""
def __init__(self, parent, handlerObj, giface, model, id=wx.ID_ANY,
**kwargs):
self.parent = parent
self._handlerObj = handlerObj
self._giface = giface
self.showNotification = Signal('SearchModuleWindow.showNotification')
wx.Panel.__init__(self, parent=parent, id=id, **kwargs)
# tree
self._tree = CTreeView(model=model, parent=self)
self._tree.SetToolTip(
_("Double-click or Ctrl-Enter to run selected module"))
# self._dataBox = wx.StaticBox(parent = self, id = wx.ID_ANY,
# label = " %s " % _("Module tree"))
# search widget
self._search = SearchModuleWidget(parent=self,
model=model,
showChoice=False)
self._search.showSearchResult.connect(
lambda result: self._tree.Select(result))
self._search.showNotification.connect(self.showNotification)
self._helpText = StaticText(
parent=self, id=wx.ID_ANY,
label="Press Enter for next match, Ctrl+Enter to run command")
self._helpText.SetForegroundColour(
wx.SystemSettings.GetColour(
wx.SYS_COLOUR_GRAYTEXT))
# buttons
self._btnRun = Button(self, id=wx.ID_OK, label=_("&Run"))
self._btnRun.SetToolTip(_("Run selected module from the tree"))
self._btnHelp = Button(self, id=wx.ID_ANY, label=_("H&elp"))
self._btnHelp.SetToolTip(
_("Show manual for selected module from the tree"))
self._btnAdvancedSearch = Button(self, id=wx.ID_ANY,
label=_("Adva&nced search..."))
self._btnAdvancedSearch.SetToolTip(
_("Do advanced search using %s module") % 'g.search.module')
# bindings
self._btnRun.Bind(wx.EVT_BUTTON, lambda evt: self.Run())
self._btnHelp.Bind(wx.EVT_BUTTON, lambda evt: self.Help())
self._btnAdvancedSearch.Bind(wx.EVT_BUTTON,
lambda evt: self.AdvancedSearch())
self.Bind(wx.EVT_KEY_UP, self.OnKeyUp)
self._tree.selectionChanged.connect(self.OnItemSelected)
self._tree.itemActivated.connect(lambda node: self.Run(node))
self._layout()
self._search.SetFocus()
def _layout(self):
"""Do dialog layout"""
sizer = wx.BoxSizer(wx.VERTICAL)
# body
dataSizer = wx.BoxSizer(wx.HORIZONTAL)
dataSizer.Add(self._tree, proportion=1,
flag=wx.EXPAND)
# buttons
btnSizer = wx.BoxSizer(wx.HORIZONTAL)
btnSizer.Add(self._btnAdvancedSearch, proportion=0)
btnSizer.AddStretchSpacer()
btnSizer.Add(self._btnHelp, proportion=0)
btnSizer.Add(self._btnRun, proportion=0)
sizer.Add(dataSizer, proportion=1,
flag=wx.EXPAND | wx.ALL, border=5)
sizer.Add(self._search, proportion=0,
flag=wx.EXPAND | wx.LEFT | wx.RIGHT | wx.BOTTOM, border=5)
sizer.Add(btnSizer, proportion=0,
flag=wx.EXPAND | wx.LEFT | wx.RIGHT | wx.BOTTOM, border=5)
sizer.Add(self._helpText,
proportion=0, flag=wx.EXPAND | wx.LEFT, border=5)
sizer.Fit(self)
sizer.SetSizeHints(self)
self.SetSizer(sizer)
self.Fit()
self.SetAutoLayout(True)
self.Layout()
def _GetSelectedNode(self):
selection = self._tree.GetSelected()
if not selection:
return None
return selection[0]
def Run(self, node=None):
"""Run selected command.
:param node: a tree node associated with the module or other item
"""
if not node:
node = self._GetSelectedNode()
# nothing selected
if not node:
return
data = node.data
# non-leaf nodes
if not data:
return
# extract name of the handler and create a new call
handler = 'self._handlerObj.' + data['handler'].lstrip('self.')
if data['command']:
eval(handler)(event=None, cmd=data['command'].split())
else:
eval(handler)(event=None)
def Help(self, node=None):
"""Show documentation for a module"""
if not node:
node = self._GetSelectedNode()
# nothing selected
if not node:
return
data = node.data
# non-leaf nodes
if not data:
return
if not data['command']:
# showing nothing for non-modules
return
# strip parameters from command if present
name = data['command'].split()[0]
self._giface.Help(name)
self.showNotification.emit(
message=_("Documentation for %s is now open in the web browser")
% name)
def AdvancedSearch(self):
"""Show advanced search window"""
self._handlerObj.RunMenuCmd(cmd=['g.search.modules'])
def OnKeyUp(self, event):
"""Key or key combination pressed"""
if event.ControlDown() and \
event.GetKeyCode() in (wx.WXK_RETURN, wx.WXK_NUMPAD_ENTER):
self.Run()
def OnItemSelected(self, node):
"""Item selected"""
data = node.data
if not data or 'command' not in data:
return
if data['command']:
label = data['command']
if data['description']:
label += ' -- ' + data['description']
else:
label = data['description']
self.showNotification.emit(message=label)
class LocationDownloadPanel(wx.Panel):
"""Panel to select and initiate downloads of locations.
Has a place to report errors to user and also any potential problems
before the user hits the button.
In the future, it can potentially show also some details about what
will be downloaded. The choice widget can be also replaced.
For the future, there can be multiple panels with different methods
or sources, e.g. direct input of URL. These can be in separate tabs
of one panel (perhaps sharing the common background download and
message logic).
"""
def __init__(self, parent, database, locations=LOCATIONS):
"""
:param database: directory with G database to download to
:param locations: list of dictionaries with label and url
"""
wx.Panel.__init__(self, parent=parent)
self.parent = parent
self._last_downloaded_location_name = None
self._download_in_progress = False
self.database = database
self.locations = locations
self._abort_btn_label = _("Abort")
self._abort_btn_tooltip = _("Abort download location")
self.label = StaticText(parent=self,
label=_("Select sample location to download:"))
choices = []
for item in self.locations:
choices.append(item["label"])
self.choice = wx.Choice(parent=self, choices=choices)
self.choice.Bind(wx.EVT_CHOICE, self.OnChangeChoice)
self.parent.download_button.Bind(wx.EVT_BUTTON, self.OnDownload)
# TODO: add button for a link to an associated website?
# TODO: add thumbnail for each location?
# TODO: messages copied from gis_set.py, need this as API?
self.message = StaticText(parent=self, size=(-1, 50))
sys.stdout = RedirectText(self.message)
# It is not clear if all wx versions supports color, so try-except.
# The color itself may not be correct for all platforms/system settings
# but in http://xoomer.virgilio.it/infinity77/wxPython/Widgets/wx.SystemSettings.html
# there is no 'warning' color.
try:
self.message.SetForegroundColour(wx.Colour(255, 0, 0))
except AttributeError:
pass
self._layout()
default = 0
self.choice.SetSelection(default)
self.CheckItem(self.locations[default])
self.thread = gThread()
def _layout(self):
"""Create and layout sizers"""
vertical = wx.BoxSizer(wx.VERTICAL)
self.sizer = vertical
vertical.Add(
self.label,
proportion=0,
flag=wx.EXPAND | wx.TOP | wx.LEFT | wx.RIGHT,
border=10,
)
vertical.Add(
self.choice,
proportion=0,
flag=wx.EXPAND | wx.TOP | wx.LEFT | wx.RIGHT,
border=10,
)
vertical.AddStretchSpacer()
vertical.Add(
self.message,
proportion=0,
flag=wx.ALIGN_LEFT | wx.ALL | wx.EXPAND,
border=10,
)
self.SetSizer(vertical)
vertical.Fit(self)
self.Layout()
self.SetMinSize(self.GetBestSize())
def _change_download_btn_label(self,
label=_("Do&wnload"),
tooltip=_("Download selected location")):
"""Change download button label/tooltip"""
if self.parent.download_button:
self.parent.download_button.SetLabel(label)
self.parent.download_button.SetToolTip(tooltip)
def OnDownload(self, event):
"""Handle user-initiated action of download"""
button_label = self.parent.download_button.GetLabel()
if button_label in (_("Download"), _("Do&wnload")):
self._change_download_btn_label(
label=self._abort_btn_label,
tooltip=self._abort_btn_tooltip,
)
Debug.msg(1, "OnDownload")
if self._download_in_progress:
self._warning(
_("Download in progress, wait until it is finished"))
index = self.choice.GetSelection()
self.DownloadItem(self.locations[index])
else:
self.parent.OnCancel()
def DownloadItem(self, item):
"""Download the selected item"""
Debug.msg(1, "DownloadItem: %s" % item)
# similar code as in CheckItem
url = item["url"]
dirname = location_name_from_url(url)
destination = os.path.join(self.database, dirname)
if os.path.exists(destination):
self._error(
_("Location named <%s> already exists,"
" download canceled") % dirname)
self._change_download_btn_label()
return
def download_complete_callback(event):
self._download_in_progress = False
errors = event.ret
if errors:
self._error(_("Download failed: %s") % errors)
else:
self._last_downloaded_location_name = dirname
self._warning(
_("Download completed. The downloaded sample data is listed "
"in the location/mapset tabs upon closing of this window"
))
self._change_download_btn_label()
def terminate_download_callback(event):
# Clean up after urllib urlretrieve which is used internally
# in grass.utils.
from urllib import request # pylint: disable=import-outside-toplevel
self._download_in_progress = False
request.urlcleanup()
sys.stdout.write("Download aborted")
self.thread = gThread()
self._change_download_btn_label()
self._download_in_progress = True
self._warning(_("Download in progress, wait until it is finished"))
self.thread.Run(
callable=download_location,
url=url,
name=dirname,
database=self.database,
ondone=download_complete_callback,
onterminate=terminate_download_callback,
)
def OnChangeChoice(self, event):
"""React to user changing the selection"""
index = self.choice.GetSelection()
self.CheckItem(self.locations[index])
def CheckItem(self, item):
"""Check what user selected and report potential issues"""
# similar code as in DownloadItem
url = item["url"]
dirname = location_name_from_url(url)
destination = os.path.join(self.database, dirname)
if os.path.exists(destination):
self._warning(
_("Location named <%s> already exists,"
" rename it first") % dirname)
self.parent.download_button.SetLabel(label=_("Download"))
return
else:
self._clearMessage()
def GetLocation(self):
"""Get the name of the last location downloaded by the user"""
return self._last_downloaded_location_name
def _warning(self, text):
"""Displays a warning, hint or info message to the user.
This function can be used for all kinds of messages except for
error messages.
.. note::
There is no cleaning procedure. You should call
_clearMessage() when you know that there is everything
correct.
"""
sys.stdout.write(text)
self.sizer.Layout()
def _error(self, text):
"""Displays a error message to the user.
This function should be used only when something serious and unexpected
happens, otherwise _showWarning should be used.
.. note::
There is no cleaning procedure. You should call
_clearMessage() when you know that there is everything
correct.
"""
sys.stdout.write(_("Error: {text}").format(text=text))
self.sizer.Layout()
def _clearMessage(self):
"""Clears/hides the error message."""
# we do no hide widget
# because we do not want the dialog to change the size
self.message.SetLabel("")
self.sizer.Layout()
