frame.py 81 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357
  1. """
  2. @package main_window::frame
  3. @brief Single Window layout - main menu, main toolbars, dockable
  4. panes for display management and access to command console.
  5. Classes:
  6. - frame::GMFrame
  7. (C) 2006-2021 by the GRASS Development Team
  8. This program is free software under the GNU General Public License
  9. (>=v2). Read the file COPYING that comes with GRASS for details.
  10. @author Michael Barton (Arizona State University)
  11. @author Jachym Cepicky (Mendel University of Agriculture)
  12. @author Martin Landa <landa.martin gmail.com>
  13. @author Vaclav Petras <wenzeslaus gmail.com> (menu customization)
  14. """
  15. import sys
  16. import os
  17. import stat
  18. import platform
  19. import re
  20. from core import globalvar
  21. try:
  22. from agw import aui
  23. except ImportError:
  24. import wx.lib.agw.aui as aui
  25. import wx
  26. try:
  27. import wx.lib.agw.flatnotebook as FN
  28. except ImportError:
  29. import wx.lib.flatnotebook as FN
  30. if os.path.join(globalvar.ETCDIR, "python") not in sys.path:
  31. sys.path.append(os.path.join(globalvar.ETCDIR, "python"))
  32. from grass.script import core as grass
  33. from grass.script.utils import decode
  34. from core.gcmd import RunCommand, GError, GMessage
  35. from core.settings import UserSettings, GetDisplayVectSettings
  36. from core.utils import SetAddOnPath, GetLayerNameFromCmd, command2ltype, get_shell_pid
  37. from gui_core.preferences import MapsetAccess, PreferencesDialog
  38. from lmgr.layertree import LayerTree, LMIcons
  39. from lmgr.menudata import LayerManagerMenuData, LayerManagerModuleTree
  40. from gui_core.widgets import GNotebook
  41. from core.gconsole import GConsole, EVT_IGNORED_CMD_RUN
  42. from core.giface import Notification
  43. from gui_core.goutput import GConsoleWindow, GC_PROMPT
  44. from gui_core.dialogs import (
  45. LocationDialog,
  46. MapsetDialog,
  47. CreateNewVector,
  48. GroupDialog,
  49. MapLayersDialog,
  50. QuitDialog,
  51. )
  52. from gui_core.menu import SearchModuleWindow
  53. from gui_core.menu import Menu as GMenu
  54. from core.debug import Debug
  55. from lmgr.toolbars import LMWorkspaceToolbar, LMToolsToolbar
  56. from lmgr.toolbars import LMMiscToolbar, LMNvizToolbar, DisplayPanelToolbar
  57. from lmgr.workspace import WorkspaceManager
  58. from lmgr.pyshell import PyShellWindow
  59. from lmgr.giface import (
  60. LayerManagerGrassInterface,
  61. LayerManagerGrassInterfaceForMapDisplay,
  62. )
  63. from mapdisp.frame import MapPanel
  64. from datacatalog.catalog import DataCatalog
  65. from gui_core.forms import GUI
  66. from gui_core.wrap import Menu, TextEntryDialog, SimpleTabArt
  67. from startup.guiutils import (
  68. can_switch_mapset_interactive,
  69. switch_mapset_interactively,
  70. create_mapset_interactively,
  71. create_location_interactively,
  72. )
  73. from grass.grassdb.checks import is_first_time_user
  74. class GMFrame(wx.Frame):
  75. """Single Window Layout which will be parallelly developed next to the
  76. current Multi Window layout solution."""
  77. def __init__(
  78. self,
  79. parent,
  80. id=wx.ID_ANY,
  81. title=None,
  82. workspace=None,
  83. size=globalvar.GM_WINDOW_SIZE,
  84. style=wx.DEFAULT_FRAME_STYLE,
  85. **kwargs,
  86. ):
  87. self.parent = parent
  88. if title:
  89. self.baseTitle = title
  90. else:
  91. self.baseTitle = _("GRASS GIS")
  92. self.iconsize = (16, 16)
  93. self.displayIndex = 0 # index value for map displays and layer trees
  94. self.currentPage = None # currently selected page for layer tree notebook
  95. self.currentPageNum = (
  96. None # currently selected page number for layer tree notebook
  97. )
  98. self.cwdPath = None # current working directory
  99. wx.Frame.__init__(self, parent=parent, id=id, size=size, style=style, **kwargs)
  100. self._giface = LayerManagerGrassInterface(self)
  101. # workspace manager
  102. self.workspace_manager = WorkspaceManager(lmgr=self, giface=self._giface)
  103. self._setTitle()
  104. self.SetName("LayerManager")
  105. self.SetIcon(
  106. wx.Icon(os.path.join(globalvar.ICONDIR, "grass.ico"), wx.BITMAP_TYPE_ICO)
  107. )
  108. menu_errors = []
  109. def add_menu_error(message):
  110. menu_errors.append(message)
  111. def show_menu_errors(messages):
  112. if messages:
  113. self._gconsole.WriteError(
  114. _("There were some issues when loading menu" " or Tools:")
  115. )
  116. for message in messages:
  117. self._gconsole.WriteError(message)
  118. # the main menu bar
  119. self._menuTreeBuilder = LayerManagerMenuData(message_handler=add_menu_error)
  120. # the search tree and command console
  121. self._moduleTreeBuilder = LayerManagerModuleTree(message_handler=add_menu_error)
  122. self._auimgr = aui.AuiManager(self)
  123. # list of open dialogs
  124. self.dialogs = dict()
  125. self.dialogs["preferences"] = None
  126. self.dialogs["nvizPreferences"] = None
  127. self.dialogs["atm"] = list()
  128. # set pane sizes according to the full screen size of the primary monitor
  129. size = wx.Display().GetGeometry().GetSize()
  130. self.PANE_BEST_SIZE = tuple(t // 3 for t in size)
  131. self.PANE_MIN_SIZE = tuple(t // 5 for t in size)
  132. # create widgets and build panes
  133. self.CreateMenuBar()
  134. self.CreateStatusBar(number=1)
  135. self.BuildPanes()
  136. self.BindEvents()
  137. self._giface.mapCreated.connect(self.OnMapCreated)
  138. self._giface.updateMap.connect(self._updateCurrentMap)
  139. self._giface.currentMapsetChanged.connect(self.OnMapsetChanged)
  140. # use default window layout ?
  141. if UserSettings.Get(group="general", key="defWindowPos", subkey="enabled"):
  142. dim = UserSettings.Get(group="general", key="defWindowPos", subkey="dim")
  143. try:
  144. x, y = map(int, dim.split(",")[0:2])
  145. w, h = map(int, dim.split(",")[2:4])
  146. self.SetPosition((x, y))
  147. self.SetSize((w, h))
  148. except Exception:
  149. pass
  150. else:
  151. # does center (of screen) make sense for lmgr?
  152. self.Centre()
  153. self.Layout()
  154. self.Show()
  155. self.Maximize(True)
  156. # load workspace file if requested
  157. if workspace:
  158. if self.workspace_manager.Load(workspace):
  159. self._setTitle()
  160. else:
  161. # start default initial display
  162. self.NewDisplay(show=False)
  163. # show map display window
  164. # -> OnSize() -> UpdateMap()
  165. for mapdisp in self.GetMapDisplay(onlyCurrent=False):
  166. mapdisp.Show()
  167. # redirect stderr to log area
  168. self._gconsole.Redirect()
  169. # fix goutput's pane size (required for Mac OSX)`
  170. self.goutput.SetSashPosition(int(self.GetSize()[1] * 0.8))
  171. show_menu_errors(menu_errors)
  172. # start with layer manager on top
  173. if self.currentPage:
  174. self.GetMapDisplay().Raise()
  175. wx.CallAfter(self.Raise)
  176. self._show_demo_map()
  177. def _setTitle(self):
  178. """Set frame title"""
  179. gisenv = grass.gisenv()
  180. location = gisenv["LOCATION_NAME"]
  181. mapset = gisenv["MAPSET"]
  182. if self.workspace_manager.workspaceFile:
  183. filename = os.path.splitext(
  184. os.path.basename(self.workspace_manager.workspaceFile)
  185. )[0]
  186. self.SetTitle(
  187. "{workspace} - {location}/{mapset} - {program}".format(
  188. location=location,
  189. mapset=mapset,
  190. workspace=filename,
  191. program=self.baseTitle,
  192. )
  193. )
  194. else:
  195. self.SetTitle(
  196. "{location}/{mapset} - {program}".format(
  197. location=location, mapset=mapset, program=self.baseTitle
  198. )
  199. )
  200. def CreateMenuBar(self):
  201. """Creates menu bar"""
  202. self.menubar = GMenu(
  203. parent=self, model=self._menuTreeBuilder.GetModel(separators=True)
  204. )
  205. self.SetMenuBar(self.menubar)
  206. self.menucmd = self.menubar.GetCmd()
  207. def _createTabMenu(self):
  208. """Creates context menu for display tabs.
  209. Used to rename display.
  210. """
  211. menu = Menu()
  212. item = wx.MenuItem(menu, id=wx.ID_ANY, text=_("Rename current Map Display"))
  213. menu.AppendItem(item)
  214. self.Bind(wx.EVT_MENU, self.OnRenameDisplay, item)
  215. return menu
  216. def _setCopyingOfSelectedText(self):
  217. copy = UserSettings.Get(
  218. group="manager", key="copySelectedTextToClipboard", subkey="enabled"
  219. )
  220. self.goutput.SetCopyingOfSelectedText(copy)
  221. def IsPaneShown(self, name):
  222. """Check if pane (toolbar, ...) of given name is currently shown"""
  223. if self._auimgr.GetPane(name).IsOk():
  224. return self._auimgr.GetPane(name).IsShown()
  225. return False
  226. def _createMapNotebook(self):
  227. """Create Map Display notebook"""
  228. # create the notebook off-window to avoid flicker
  229. client_size = self.GetClientSize()
  230. notebook_style = (
  231. aui.AUI_NB_DEFAULT_STYLE | aui.AUI_NB_TAB_EXTERNAL_MOVE | wx.NO_BORDER
  232. )
  233. self.mapnotebook = aui.AuiNotebook(
  234. self,
  235. -1,
  236. wx.Point(client_size.x, client_size.y),
  237. wx.Size(430, 200),
  238. agwStyle=notebook_style,
  239. )
  240. self.mapnotebook.SetArtProvider(SimpleTabArt())
  241. # bindings
  242. self.mapnotebook.Bind(
  243. aui.EVT_AUINOTEBOOK_PAGE_CHANGED,
  244. lambda evt: self.mapnotebook.GetCurrentPage().onFocus.emit(),
  245. )
  246. self.mapnotebook.Bind(
  247. aui.EVT_AUINOTEBOOK_PAGE_CLOSE,
  248. self.OnMapNotebookClose,
  249. )
  250. def _createDataCatalog(self, parent):
  251. """Initialize Data Catalog widget"""
  252. self.datacatalog = DataCatalog(parent=parent, giface=self._giface)
  253. self.datacatalog.showNotification.connect(
  254. lambda message: self.SetStatusText(message)
  255. )
  256. def _createDisplay(self, parent):
  257. """Initialize Display widget"""
  258. # create display notebook
  259. self.notebookLayers = GNotebook(parent=parent, style=globalvar.FNPageStyle)
  260. menu = self._createTabMenu()
  261. self.notebookLayers.SetRightClickMenu(menu)
  262. # bindings
  263. self.notebookLayers.Bind(FN.EVT_FLATNOTEBOOK_PAGE_CHANGED, self.OnCBPageChanged)
  264. self.notebookLayers.Bind(FN.EVT_FLATNOTEBOOK_PAGE_CLOSING, self.OnCBPageClosing)
  265. def _createSearchModule(self, parent):
  266. """Initialize Search module widget"""
  267. if not UserSettings.Get(group="manager", key="hideTabs", subkey="search"):
  268. self.search = SearchModuleWindow(
  269. parent=parent,
  270. handlerObj=self,
  271. giface=self._giface,
  272. model=self._moduleTreeBuilder.GetModel(),
  273. )
  274. self.search.showNotification.connect(
  275. lambda message: self.SetStatusText(message)
  276. )
  277. else:
  278. self.search = None
  279. def _createConsole(self, parent):
  280. """Initialize Console widget"""
  281. # create 'command output' text area
  282. self._gconsole = GConsole(
  283. guiparent=self,
  284. giface=self._giface,
  285. ignoredCmdPattern=r"^d\..*|^r[3]?\.mapcalc$|^i.group$|^r.import$|"
  286. "^r.external$|^r.external.out$|"
  287. "^v.import$|^v.external$|^v.external.out$|"
  288. "^cd$|^cd .*",
  289. )
  290. # create 'console' widget
  291. self.goutput = GConsoleWindow(
  292. parent=parent,
  293. giface=self._giface,
  294. gconsole=self._gconsole,
  295. menuModel=self._moduleTreeBuilder.GetModel(),
  296. gcstyle=GC_PROMPT,
  297. )
  298. self.goutput.showNotification.connect(
  299. lambda message: self.SetStatusText(message)
  300. )
  301. self.goutput.contentChanged.connect(
  302. lambda notification: self._focusPage(notification)
  303. )
  304. self._gconsole.mapCreated.connect(self.OnMapCreated)
  305. self._gconsole.Bind(
  306. EVT_IGNORED_CMD_RUN, lambda event: self.RunSpecialCmd(event.cmd)
  307. )
  308. self._setCopyingOfSelectedText()
  309. def _createPythonShell(self, parent):
  310. """Initialize Python shell widget"""
  311. if not UserSettings.Get(group="manager", key="hideTabs", subkey="pyshell"):
  312. self.pyshell = PyShellWindow(
  313. parent=parent,
  314. giface=self._giface,
  315. simpleEditorHandler=self.OnSimpleEditor,
  316. )
  317. else:
  318. self.pyshell = None
  319. def OnNewDisplay(self, event=None):
  320. """Create new layer tree and map display window instance"""
  321. self.NewDisplay()
  322. def NewDisplay(self, name=None, show=True):
  323. """Create new layer tree structure and associated map display and
  324. add it to display notebook tab
  325. :param name: name of new map display window
  326. :param show: show map display window if True
  327. """
  328. Debug.msg(1, "GMFrame.NewDisplay(): idx=%d" % self.displayIndex)
  329. if not name:
  330. name = _("Map Display {number}").format(number=self.displayIndex + 1)
  331. # make a new page in the bookcontrol for the layer tree (on page 0 of
  332. # the notebook)
  333. self.pg_panel = wx.Panel(
  334. self.notebookLayers, id=wx.ID_ANY, style=wx.BORDER_NONE
  335. )
  336. # create display toolbar
  337. dmgrToolbar = DisplayPanelToolbar(guiparent=self.pg_panel, parent=self)
  338. self.notebookLayers.AddPage(page=self.pg_panel, text=name, select=True)
  339. self.currentPage = self.notebookLayers.GetCurrentPage()
  340. self.currentPageNum = self.notebookLayers.GetSelection()
  341. self.notebookLayers.EnsureVisible(self.currentPageNum)
  342. def CreateNewMapDisplay(layertree):
  343. """Callback function which creates a new Map Display window
  344. :param layertree: layer tree object
  345. :return: reference to mapdisplay instance
  346. """
  347. # create instance of Map Display interface
  348. self._gifaceForDisplay = LayerManagerGrassInterfaceForMapDisplay(
  349. self._giface, layertree
  350. )
  351. # create Map Display
  352. mapdisplay = MapPanel(
  353. parent=self.mapnotebook,
  354. giface=self._gifaceForDisplay,
  355. id=wx.ID_ANY,
  356. tree=layertree,
  357. lmgr=self,
  358. Map=layertree.Map,
  359. title=name,
  360. size=globalvar.MAP_WINDOW_SIZE,
  361. )
  362. # add map display panel to notebook and make it current
  363. self.mapnotebook.AddPage(mapdisplay, name)
  364. self.mapnotebook.SetSelection(self.currentPageNum)
  365. # set map display properties
  366. self._setUpMapDisplay(mapdisplay)
  367. return mapdisplay
  368. # create layer tree (tree control for managing GIS layers) and put on
  369. # new notebook page and new map display frame
  370. self.currentPage.maptree = LayerTree(
  371. parent=self.currentPage,
  372. giface=self._giface,
  373. createNewMapDisplay=CreateNewMapDisplay,
  374. id=wx.ID_ANY,
  375. pos=wx.DefaultPosition,
  376. size=wx.DefaultSize,
  377. style=wx.TR_HAS_BUTTONS
  378. | wx.TR_LINES_AT_ROOT
  379. | wx.TR_HIDE_ROOT
  380. | wx.TR_DEFAULT_STYLE
  381. | wx.NO_BORDER
  382. | wx.FULL_REPAINT_ON_RESIZE,
  383. lmgr=self,
  384. notebook=self.notebookLayers,
  385. title=name,
  386. )
  387. # layout for controls
  388. cb_boxsizer = wx.BoxSizer(wx.VERTICAL)
  389. cb_boxsizer.Add(dmgrToolbar, proportion=0, flag=wx.EXPAND)
  390. cb_boxsizer.Add(self.GetLayerTree(), proportion=1, flag=wx.EXPAND, border=1)
  391. self.currentPage.SetSizer(cb_boxsizer)
  392. cb_boxsizer.Fit(self.GetLayerTree())
  393. self.currentPage.Layout()
  394. self.GetLayerTree().Layout()
  395. self.displayIndex += 1
  396. return self.GetMapDisplay()
  397. def _setUpMapDisplay(self, mapdisplay):
  398. """Set up Map Display properties"""
  399. page = self.currentPage
  400. def CanCloseDisplay(askIfSaveWorkspace):
  401. """Callback to check if user wants to close display. Map
  402. Display index can be different from index in Display tab.
  403. :return dict/None pgnum_dict/None: dict "layers" key represent
  404. map display notebook layers
  405. tree page index and
  406. "mapnotebook" key represent
  407. map display notebook page
  408. index (single window mode)
  409. """
  410. pgnum_dict = {}
  411. pgnum_dict["layers"] = self.notebookLayers.GetPageIndex(page)
  412. pgnum_dict["mapnotebook"] = self.mapnotebook.GetPageIndex(mapdisplay)
  413. name = self.notebookLayers.GetPageText(pgnum_dict["layers"])
  414. caption = _("Close Map Display {}").format(name)
  415. if not askIfSaveWorkspace or (
  416. askIfSaveWorkspace and self.workspace_manager.CanClosePage(caption)
  417. ):
  418. return pgnum_dict
  419. return None
  420. mapdisplay.canCloseDisplayCallback = CanCloseDisplay
  421. # bind various events
  422. mapdisplay.onFocus.connect(
  423. lambda page=self.currentPage: self._onMapDisplayFocus(page),
  424. )
  425. mapdisplay.starting3dMode.connect(
  426. lambda firstTime, mapDisplayPage=self.currentPage: self._onStarting3dMode(
  427. mapDisplayPage
  428. )
  429. )
  430. mapdisplay.starting3dMode.connect(self.AddNvizTools)
  431. mapdisplay.ending3dMode.connect(self.RemoveNvizTools)
  432. mapdisplay.closingDisplay.connect(self._closePageNoEvent)
  433. # set default properties
  434. mapdisplay.SetProperties(
  435. render=UserSettings.Get(
  436. group="display", key="autoRendering", subkey="enabled"
  437. ),
  438. mode=UserSettings.Get(
  439. group="display", key="statusbarMode", subkey="selection"
  440. ),
  441. alignExtent=UserSettings.Get(
  442. group="display", key="alignExtent", subkey="enabled"
  443. ),
  444. constrainRes=UserSettings.Get(
  445. group="display", key="compResolution", subkey="enabled"
  446. ),
  447. showCompExtent=UserSettings.Get(
  448. group="display", key="showCompExtent", subkey="enabled"
  449. ),
  450. )
  451. def BuildPanes(self):
  452. """Build panes - toolbars as well as panels"""
  453. self._auimgr.SetAutoNotebookTabArt(SimpleTabArt())
  454. # initialize all main widgets
  455. self._createMapNotebook()
  456. self._createDataCatalog(parent=self)
  457. self._createDisplay(parent=self)
  458. self._createSearchModule(parent=self)
  459. self._createConsole(parent=self)
  460. self._createPythonShell(parent=self)
  461. self.toolbars = {
  462. "workspace": LMWorkspaceToolbar(parent=self),
  463. "tools": LMToolsToolbar(parent=self),
  464. "misc": LMMiscToolbar(parent=self),
  465. "nviz": LMNvizToolbar(parent=self),
  466. }
  467. self._toolbarsData = {
  468. "workspace": (
  469. "toolbarWorkspace", # name
  470. _("Workspace Toolbar"), # caption
  471. 1,
  472. 0,
  473. ), # row, position
  474. "tools": ("toolbarTools", _("Tools Toolbar"), 1, 1),
  475. "misc": ("toolbarMisc", _("Misc Toolbar"), 1, 2),
  476. "nviz": ("toolbarNviz", _("3D view Toolbar"), 1, 3),
  477. }
  478. # add a bunch of panes
  479. toolbarsList = ("workspace", "tools", "misc", "nviz")
  480. for toolbar in toolbarsList:
  481. name, caption, row, position = self._toolbarsData[toolbar]
  482. self._auimgr.AddPane(
  483. self.toolbars[toolbar],
  484. aui.AuiPaneInfo()
  485. .Name(name)
  486. .Caption(caption)
  487. .ToolbarPane()
  488. .Top()
  489. .Row(row)
  490. .Position(position)
  491. .LeftDockable(False)
  492. .RightDockable(False)
  493. .BottomDockable(False)
  494. .TopDockable(True)
  495. .CloseButton(False)
  496. .Layer(2)
  497. .BestSize((self.toolbars[toolbar].GetBestSize())),
  498. )
  499. self._auimgr.AddPane(
  500. self.mapnotebook,
  501. aui.AuiPaneInfo().Name("map display content").CenterPane().PaneBorder(True),
  502. )
  503. self._auimgr.AddPane(
  504. self.datacatalog,
  505. aui.AuiPaneInfo()
  506. .Name("datacatalog")
  507. .Caption("Data Catalog")
  508. .Left()
  509. .Layer(1)
  510. .Position(1)
  511. .BestSize(self.PANE_BEST_SIZE)
  512. .MinSize(self.PANE_MIN_SIZE)
  513. .CloseButton(False)
  514. .MinimizeButton(True)
  515. .MaximizeButton(True),
  516. )
  517. self._auimgr.AddPane(
  518. self.notebookLayers,
  519. aui.AuiPaneInfo()
  520. .Name("layers")
  521. .Caption("Layers")
  522. .Left()
  523. .Layer(1)
  524. .Position(2)
  525. .BestSize(self.PANE_BEST_SIZE)
  526. .MinSize(self.PANE_MIN_SIZE)
  527. .CloseButton(False)
  528. .MinimizeButton(True)
  529. .MaximizeButton(True),
  530. )
  531. self._auimgr.AddPane(
  532. self.search,
  533. aui.AuiPaneInfo()
  534. .Name("tools")
  535. .Caption("Tools")
  536. .Right()
  537. .Layer(1)
  538. .Position(1)
  539. .BestSize(self.PANE_BEST_SIZE)
  540. .MinSize(self.PANE_MIN_SIZE)
  541. .CloseButton(False)
  542. .MinimizeButton(True)
  543. .MaximizeButton(True),
  544. )
  545. self._auimgr.AddPane(
  546. self.goutput,
  547. aui.AuiPaneInfo()
  548. .Name("console")
  549. .Caption("Console")
  550. .Right()
  551. .BestSize(self.PANE_BEST_SIZE)
  552. .MinSize(self.PANE_MIN_SIZE)
  553. .CloseButton(False)
  554. .MinimizeButton(True)
  555. .MaximizeButton(True),
  556. target=self._auimgr.GetPane("tools"),
  557. )
  558. self._auimgr.AddPane(
  559. self.pyshell,
  560. aui.AuiPaneInfo()
  561. .Name("python")
  562. .Caption("Python")
  563. .Right()
  564. .BestSize(self.PANE_BEST_SIZE)
  565. .MinSize(self.PANE_MIN_SIZE)
  566. .CloseButton(False)
  567. .MinimizeButton(True)
  568. .MaximizeButton(True),
  569. target=self._auimgr.GetPane("tools"),
  570. )
  571. self._auimgr.GetPane("toolbarNviz").Hide()
  572. # Set Tools as active tab
  573. tools = self._auimgr.GetPane("tools")
  574. notebook = self._auimgr.GetNotebooks()[0]
  575. notebook.SetSelectionToPage(tools)
  576. # Set the size for automatic notebook
  577. pane = self._auimgr.GetPane(notebook)
  578. pane.MinSize(self.search.GetMinSize())
  579. wx.CallAfter(self.datacatalog.LoadItems)
  580. self._auimgr.Update()
  581. def BindEvents(self):
  582. # bindings
  583. self.Bind(wx.EVT_CLOSE, self.OnCloseWindowOrExit)
  584. self.Bind(wx.EVT_KEY_DOWN, self.OnKeyDown)
  585. def _show_demo_map(self):
  586. """If in demolocation, add demo map to map display
  587. This provides content for first-time user experience.
  588. """
  589. def show_demo():
  590. layer_name = "country_boundaries@PERMANENT"
  591. exists = grass.find_file(name=layer_name, element="vector")["name"]
  592. if not exists:
  593. # Do not fail nor report errors to the first-time user when not found.
  594. Debug.msg(
  595. 5, "GMFrame._show_demo_map(): {} does not exist".format(layer_name)
  596. )
  597. return
  598. self.GetLayerTree().AddLayer(
  599. ltype="vector",
  600. lname=layer_name,
  601. lchecked=True,
  602. lcmd=["d.vect", "map={}".format(layer_name)],
  603. )
  604. if is_first_time_user():
  605. # Show only after everything is initialized for proper map alignment.
  606. wx.CallLater(1000, show_demo)
  607. def AddNvizTools(self, firstTime):
  608. """Add nviz notebook page
  609. :param firstTime: if a mapdisplay is starting 3D mode for the
  610. first time
  611. """
  612. Debug.msg(5, "GMFrame.AddNvizTools()")
  613. from nviz.main import haveNviz
  614. if not haveNviz:
  615. return
  616. from nviz.main import NvizToolWindow
  617. # show toolbar
  618. self._auimgr.GetPane("toolbarNviz").Show()
  619. # reorder other toolbars
  620. for pos, toolbar in enumerate(
  621. ("toolbarWorkspace", "toolbarTools", "toolbarMisc", "toolbarNviz")
  622. ):
  623. self._auimgr.GetPane(toolbar).Row(1).Position(pos)
  624. # create nviz tools tab
  625. self.nviz = NvizToolWindow(
  626. parent=self, tree=self.GetLayerTree(), display=self.GetMapDisplay()
  627. )
  628. self._auimgr.AddPane(
  629. self.nviz,
  630. aui.AuiPaneInfo()
  631. .Name("nviz")
  632. .Caption("3D view")
  633. .Left()
  634. .Layer(1)
  635. .Position(3)
  636. .BestSize(self.PANE_BEST_SIZE)
  637. .MinSize(self.PANE_MIN_SIZE)
  638. .CloseButton(False)
  639. .MinimizeButton(True)
  640. .MaximizeButton(True),
  641. )
  642. self._auimgr.GetPane("nviz").Show()
  643. self._auimgr.Update()
  644. # this is a bit strange here since a new window is created everytime
  645. if not firstTime:
  646. for page in ("view", "light", "fringe", "constant", "cplane", "animation"):
  647. self.nviz.UpdatePage(page)
  648. def RemoveNvizTools(self):
  649. """Remove nviz notebook page"""
  650. # if more mapwindow3D were possible, check here if nb page should be
  651. # removed
  652. # hide toolbar
  653. self._auimgr.GetPane("toolbarNviz").Hide()
  654. for pos, toolbar in enumerate(
  655. ("toolbarWorkspace", "toolbarTools", "toolbarMisc")
  656. ):
  657. self._auimgr.GetPane(toolbar).Row(1).Position(pos)
  658. self._auimgr.DetachPane(self.nviz)
  659. self.nviz.Destroy()
  660. self._auimgr.Update()
  661. def OnLocationWizard(self, event):
  662. """Launch location wizard"""
  663. gisenv = grass.gisenv()
  664. grassdb, location, mapset = create_location_interactively(
  665. self, gisenv["GISDBASE"]
  666. )
  667. if location:
  668. self._giface.grassdbChanged.emit(
  669. grassdb=grassdb, location=location, action="new", element="location"
  670. )
  671. if grassdb == gisenv["GISDBASE"]:
  672. switch_grassdb = None
  673. else:
  674. switch_grassdb = grassdb
  675. if can_switch_mapset_interactive(self, grassdb, location, mapset):
  676. switch_mapset_interactively(
  677. self,
  678. self._giface,
  679. switch_grassdb,
  680. location,
  681. mapset,
  682. show_confirmation=True,
  683. )
  684. def OnSettingsChanged(self):
  685. """Here can be functions which have to be called
  686. after receiving settingsChanged signal.
  687. Now only set copying of selected text to clipboard (in goutput).
  688. """
  689. # self._createMenuBar() # bug when menu is re-created on the fly
  690. self._setCopyingOfSelectedText()
  691. def OnGCPManager(self, event=None, cmd=None):
  692. """Launch georectifier module. See OnIClass documentation"""
  693. from gcp.manager import GCPWizard
  694. GCPWizard(self, self._giface)
  695. def OnGModeler(self, event=None, cmd=None):
  696. """Launch Graphical Modeler. See OnIClass documentation"""
  697. from gmodeler.frame import ModelFrame
  698. win = ModelFrame(parent=self, giface=self._giface)
  699. win.CentreOnScreen()
  700. win.Show()
  701. def OnPsMap(self, event=None, cmd=None):
  702. """Launch Cartographic Composer. See OnIClass documentation"""
  703. from psmap.frame import PsMapFrame
  704. win = PsMapFrame(parent=self)
  705. win.CentreOnScreen()
  706. win.Show()
  707. def OnMapSwipe(self, event=None, cmd=None):
  708. """Launch Map Swipe. See OnIClass documentation"""
  709. from mapswipe.frame import SwipeMapDisplay
  710. frame = wx.Frame(
  711. parent=None, size=globalvar.MAP_WINDOW_SIZE, title=_("Map Swipe Tool")
  712. )
  713. win = SwipeMapDisplay(
  714. parent=frame,
  715. giface=self._giface,
  716. )
  717. rasters = []
  718. tree = self.GetLayerTree()
  719. if tree:
  720. for layer in tree.GetSelections():
  721. if tree.GetLayerInfo(layer, key="maplayer").GetType() != "raster":
  722. continue
  723. rasters.append(tree.GetLayerInfo(layer, key="maplayer").GetName())
  724. if len(rasters) >= 1:
  725. win.SetFirstRaster(rasters[0])
  726. if len(rasters) >= 2:
  727. win.SetSecondRaster(rasters[1])
  728. win.SetRasterNames()
  729. win.CentreOnScreen()
  730. win.Show()
  731. def OnRLiSetup(self, event=None, cmd=None):
  732. """Launch r.li setup. See OnIClass documentation"""
  733. from rlisetup.frame import RLiSetupFrame
  734. win = RLiSetupFrame(parent=self)
  735. win.CentreOnScreen()
  736. win.Show()
  737. def OnDataCatalog(self, event=None, cmd=None):
  738. """Launch Data Catalog"""
  739. from datacatalog.frame import DataCatalogFrame
  740. win = DataCatalogFrame(parent=self, giface=self._giface)
  741. win.CentreOnScreen()
  742. win.Show()
  743. def OnDone(self, event):
  744. """Command execution finished"""
  745. if hasattr(self, "model"):
  746. self.model.DeleteIntermediateData(log=self._gconsole)
  747. del self.model
  748. self.SetStatusText("")
  749. def OnRunModel(self, event):
  750. """Run model"""
  751. filename = ""
  752. dlg = wx.FileDialog(
  753. parent=self,
  754. message=_("Choose model to run"),
  755. defaultDir=os.getcwd(),
  756. wildcard=_("GRASS Model File (*.gxm)|*.gxm"),
  757. )
  758. if dlg.ShowModal() == wx.ID_OK:
  759. filename = dlg.GetPath()
  760. if not filename:
  761. dlg.Destroy()
  762. return
  763. from gmodeler.model import Model
  764. self.model = Model()
  765. self.model.LoadModel(filename)
  766. self.model.Run(log=self.GetLogWindow(), onDone=self.OnDone, parent=self)
  767. dlg.Destroy()
  768. def OnMapsets(self, event):
  769. """Launch mapset access dialog"""
  770. dlg = MapsetAccess(parent=self, id=wx.ID_ANY)
  771. dlg.CenterOnScreen()
  772. if dlg.ShowModal() == wx.ID_OK:
  773. ms = dlg.GetMapsets()
  774. RunCommand(
  775. "g.mapsets", parent=self, mapset="%s" % ",".join(ms), operation="set"
  776. )
  777. def OnCBPageChanged(self, event):
  778. """Page in notebook (display) changed.
  779. Also change active map notebook tab."""
  780. self.currentPage = self.notebookLayers.GetCurrentPage()
  781. self.currentPageNum = self.notebookLayers.GetSelection()
  782. try:
  783. self.mapnotebook.SetSelection(self.GetMapDisplayIndex())
  784. except Exception:
  785. pass
  786. event.Skip()
  787. def OnCBPageClosing(self, event):
  788. """Page of notebook is being closed
  789. from Layer Manager (x button next to arrows)
  790. Also close associated map display.
  791. """
  792. # save changes in the workspace
  793. name = self.notebookLayers.GetPageText(event.GetSelection())
  794. caption = _("Close Map Display {}").format(name)
  795. if not self.workspace_manager.CanClosePage(caption):
  796. event.Veto()
  797. return
  798. maptree = self.notebookLayers.GetPage(event.GetSelection()).maptree
  799. maptree.GetMapDisplay().CleanUp()
  800. self.mapnotebook.DeletePage(self.GetMapDisplayIndex())
  801. maptree.Close(True)
  802. self.currentPage = None
  803. event.Skip()
  804. def _closePageNoEvent(self, pgnum_dict):
  805. """Close page and destroy map display without generating notebook
  806. page closing event.
  807. :param dict pgnum_dict: dict "layers" key represent map display
  808. notebook layers tree page index and
  809. "mapnotebook" key represent map display
  810. notebook page index (single window mode)
  811. """
  812. self.notebookLayers.Unbind(FN.EVT_FLATNOTEBOOK_PAGE_CLOSING)
  813. self.notebookLayers.DeletePage(pgnum_dict["layers"])
  814. self.notebookLayers.Bind(
  815. FN.EVT_FLATNOTEBOOK_PAGE_CLOSING,
  816. self.OnCBPageClosing,
  817. )
  818. self.mapnotebook.DeletePage(pgnum_dict["mapnotebook"])
  819. def _focusPage(self, notification):
  820. """Focus the 'Console' notebook page according to event notification."""
  821. if (
  822. notification == Notification.HIGHLIGHT
  823. or notification == Notification.MAKE_VISIBLE
  824. or notification == Notification.RAISE_WINDOW
  825. ):
  826. self.FocusPage("Console")
  827. def FocusPage(self, page_text):
  828. """Focus the page if part of any of aui notebooks"""
  829. notebooks = self._auimgr.GetNotebooks()
  830. for notebook in notebooks:
  831. for i in range(notebook.GetPageCount()):
  832. if notebook.GetPageText(i) == page_text:
  833. notebook.SetSelection(i)
  834. def RunSpecialCmd(self, command):
  835. """Run command from command line, check for GUI wrappers"""
  836. if re.compile(r"^d\..*").search(command[0]):
  837. self.RunDisplayCmd(command)
  838. elif re.compile(r"r[3]?\.mapcalc").search(command[0]):
  839. self.OnMapCalculator(event=None, cmd=command)
  840. elif command[0] == "i.group":
  841. self.OnEditImageryGroups(event=None, cmd=command)
  842. elif command[0] == "r.import":
  843. self.OnImportGdalLayers(event=None, cmd=command)
  844. elif command[0] == "r.external":
  845. self.OnLinkGdalLayers(event=None, cmd=command)
  846. elif command[0] == "r.external.out":
  847. self.OnRasterOutputFormat(event=None)
  848. elif command[0] == "v.import":
  849. self.OnImportOgrLayers(event=None, cmd=command)
  850. elif command[0] == "v.external":
  851. self.OnLinkOgrLayers(event=None, cmd=command)
  852. elif command[0] == "v.external.out":
  853. self.OnVectorOutputFormat(event=None)
  854. elif command[0] == "cd":
  855. self.OnChangeCWD(event=None, cmd=command)
  856. else:
  857. raise ValueError(
  858. "Layer Manager special command (%s)"
  859. " not supported." % " ".join(command)
  860. )
  861. def RunDisplayCmd(self, command):
  862. """Handles display commands.
  863. :param command: command in a list
  864. """
  865. if not self.currentPage:
  866. self.NewDisplay(show=True)
  867. # here should be the d.* commands which are not layers
  868. if command[0] == "d.erase":
  869. # rest of d.erase is ignored
  870. self.GetLayerTree().DeleteAllLayers()
  871. return
  872. try:
  873. # display GRASS commands
  874. layertype = command2ltype[command[0]]
  875. except KeyError:
  876. GMessage(
  877. parent=self,
  878. message=_(
  879. "Command '%s' not yet implemented in the WxGUI. "
  880. "Try adding it as a command layer instead."
  881. )
  882. % command[0],
  883. )
  884. return
  885. if layertype == "barscale":
  886. if len(command) > 1:
  887. self.GetMapDisplay().AddBarscale(cmd=command)
  888. else:
  889. self.GetMapDisplay().AddBarscale()
  890. elif layertype == "rastleg":
  891. if len(command) > 1:
  892. self.GetMapDisplay().AddLegendRast(cmd=command)
  893. else:
  894. self.GetMapDisplay().AddLegendRast()
  895. elif layertype == "vectleg":
  896. if len(command) > 1:
  897. self.GetMapDisplay().AddLegendVect(cmd=command, showDialog=False)
  898. else:
  899. self.GetMapDisplay().AddLegendVect(showDialog=True)
  900. elif layertype == "northarrow":
  901. if len(command) > 1:
  902. self.GetMapDisplay().AddArrow(cmd=command)
  903. else:
  904. self.GetMapDisplay().AddArrow()
  905. elif layertype == "text":
  906. if len(command) > 1:
  907. self.GetMapDisplay().AddDtext(cmd=command)
  908. else:
  909. self.GetMapDisplay().AddDtext()
  910. elif layertype == "redraw":
  911. self.GetMapDisplay().OnRender(None)
  912. elif layertype == "export":
  913. GUI(parent=self, show=False).ParseCommand(
  914. command, completed=(self.GetMapDisplay().DOutFileOptData, "", "")
  915. )
  916. elif layertype == "torast":
  917. if len(command) <= 1:
  918. task = GUI(parent=self, show=True).ParseCommand(
  919. command, completed=(self.GetMapDisplay().DToRastOptData, "", "")
  920. )
  921. else:
  922. task = GUI(parent=self, show=None).ParseCommand(
  923. command, completed=(self.GetMapDisplay().DToRastOptData, "", "")
  924. )
  925. self.GetMapDisplay().DToRast(command=task.get_cmd())
  926. else:
  927. # add layer into layer tree
  928. lname, found = GetLayerNameFromCmd(
  929. command, fullyQualified=True, layerType=layertype
  930. )
  931. self.GetLayerTree().AddLayer(
  932. ltype=layertype,
  933. lchecked=True if lname else None,
  934. lname=lname,
  935. lcmd=command,
  936. )
  937. def GetLayerNotebook(self):
  938. """Get Layers Notebook"""
  939. return self.notebookLayers
  940. def GetLayerTree(self):
  941. """Get current layer tree
  942. :return: LayerTree instance
  943. :return: None no layer tree selected
  944. """
  945. if self.currentPage:
  946. return self.currentPage.maptree
  947. return None
  948. def GetMapDisplay(self, onlyCurrent=True):
  949. """Get current map display
  950. :param bool onlyCurrent: True to return only active mapdisplay
  951. False for list of all mapdisplays
  952. :return: MapPanel instance (or list)
  953. :return: None no mapdisplay selected
  954. """
  955. if onlyCurrent:
  956. if self.currentPage:
  957. return self.GetLayerTree().GetMapDisplay()
  958. else:
  959. return None
  960. else: # -> return list of all mapdisplays
  961. mlist = list()
  962. for idx in range(0, self.notebookLayers.GetPageCount()):
  963. mlist.append(self.notebookLayers.GetPage(idx).maptree.GetMapDisplay())
  964. return mlist
  965. def GetAllMapDisplays(self):
  966. """Get all (open) map displays"""
  967. return self.GetMapDisplay(onlyCurrent=False)
  968. def GetMapDisplayIndex(self):
  969. """Get the index of the currently active map display tab.
  970. Can be different than index of related layertree."""
  971. return self.mapnotebook.GetPageIndex(self.GetMapDisplay())
  972. def GetLogWindow(self):
  973. """Gets console for command output and messages"""
  974. return self._gconsole
  975. def GetToolbar(self, name):
  976. """Returns toolbar if exists else None"""
  977. if name in self.toolbars:
  978. return self.toolbars[name]
  979. return None
  980. def GetMenuCmd(self, event):
  981. """Get GRASS command from menu item
  982. :return: command as a list"""
  983. layer = None
  984. if event:
  985. cmd = self.menucmd[event.GetId()]
  986. else:
  987. cmd = ""
  988. try:
  989. cmdlist = cmd.split(" ")
  990. except Exception: # already list?
  991. cmdlist = cmd
  992. # check list of dummy commands for GUI modules that do not have GRASS
  993. # bin modules or scripts.
  994. if cmd in ["vcolors", "r.mapcalc", "r3.mapcalc"]:
  995. return cmdlist
  996. try:
  997. layer = self.GetLayerTree().layer_selected
  998. name = self.GetLayerTree().GetLayerInfo(layer, key="maplayer").name
  999. type = self.GetLayerTree().GetLayerInfo(layer, key="type")
  1000. except Exception:
  1001. layer = None
  1002. if layer and len(cmdlist) == 1: # only if no parameters given
  1003. if (type == "raster" and cmdlist[0][0] == "r" and cmdlist[0][1] != "3") or (
  1004. type == "vector" and cmdlist[0][0] == "v"
  1005. ):
  1006. input = GUI().GetCommandInputMapParamKey(cmdlist[0])
  1007. if input:
  1008. cmdlist.append("%s=%s" % (input, name))
  1009. return cmdlist
  1010. def RunMenuCmd(self, event=None, cmd=[]):
  1011. """Run command selected from menu"""
  1012. if event:
  1013. cmd = self.GetMenuCmd(event)
  1014. self._gconsole.RunCmd(cmd)
  1015. def OnMenuCmd(self, event=None, cmd=[]):
  1016. """Parse command selected from menu"""
  1017. if event:
  1018. cmd = self.GetMenuCmd(event)
  1019. GUI(parent=self, giface=self._giface).ParseCommand(cmd)
  1020. def OnVNet(self, event):
  1021. """Vector network analysis tool"""
  1022. if self.GetMapDisplay():
  1023. self.GetMapDisplay().OnVNet(event)
  1024. else:
  1025. self.NewDisplay(show=True).OnVNet(event)
  1026. def OnVDigit(self, event):
  1027. """Start vector digitizer"""
  1028. if not self.currentPage:
  1029. self.MsgNoLayerSelected()
  1030. return
  1031. tree = self.GetLayerTree()
  1032. layer = tree.layer_selected
  1033. # no map layer selected
  1034. if not layer:
  1035. self.MsgNoLayerSelected()
  1036. return
  1037. # available only for vector map layers
  1038. try:
  1039. mapLayer = tree.GetLayerInfo(layer, key="maplayer")
  1040. except Exception:
  1041. mapLayer = None
  1042. if not mapLayer or mapLayer.GetType() != "vector":
  1043. GMessage(parent=self, message=_("Selected map layer is not vector."))
  1044. return
  1045. if mapLayer.GetMapset() != grass.gisenv()["MAPSET"]:
  1046. GMessage(
  1047. parent=self,
  1048. message=_(
  1049. "Editing is allowed only for vector maps from the "
  1050. "current mapset."
  1051. ),
  1052. )
  1053. return
  1054. if not tree.GetLayerInfo(layer):
  1055. return
  1056. dcmd = tree.GetLayerInfo(layer, key="cmd")
  1057. if not dcmd:
  1058. return
  1059. digitToolbar = self.GetMapDisplay().GetToolbar("vdigit")
  1060. if digitToolbar:
  1061. stopOnly = False
  1062. if mapLayer is digitToolbar.GetLayer():
  1063. stopOnly = True
  1064. tree.OnStopEditing(None) # TODO: change to signal
  1065. if stopOnly:
  1066. return
  1067. tree.OnStartEditing(None) # TODO: change to signal
  1068. def OnRunScript(self, event):
  1069. """Run user-defined script"""
  1070. # open dialog and choose script file
  1071. dlg = wx.FileDialog(
  1072. parent=self,
  1073. message=_("Choose script file to run"),
  1074. defaultDir=os.getcwd(),
  1075. wildcard=_("Python script (*.py)|*.py|Bash script (*.sh)|*.sh"),
  1076. )
  1077. filename = None
  1078. if dlg.ShowModal() == wx.ID_OK:
  1079. filename = dlg.GetPath()
  1080. if not filename:
  1081. return False
  1082. if not os.path.exists(filename):
  1083. GError(
  1084. parent=self,
  1085. message=_("Script file '%s' doesn't exist. " "Operation canceled.")
  1086. % filename,
  1087. )
  1088. return
  1089. # check permission
  1090. if not os.access(filename, os.X_OK):
  1091. dlg = wx.MessageDialog(
  1092. self,
  1093. message=_(
  1094. "Script <%s> is not executable. "
  1095. "Do you want to set the permissions "
  1096. "that allows you to run this script "
  1097. "(note that you must be the owner of the file)?"
  1098. % os.path.basename(filename)
  1099. ),
  1100. caption=_("Set permission?"),
  1101. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION,
  1102. )
  1103. if dlg.ShowModal() != wx.ID_YES:
  1104. return
  1105. dlg.Destroy()
  1106. try:
  1107. mode = stat.S_IMODE(os.lstat(filename)[stat.ST_MODE])
  1108. os.chmod(filename, mode | stat.S_IXUSR)
  1109. except OSError:
  1110. GError(_("Unable to set permission. Operation canceled."), parent=self)
  1111. return
  1112. # check GRASS_ADDON_PATH
  1113. addonPath = os.getenv("GRASS_ADDON_PATH", [])
  1114. if addonPath:
  1115. addonPath = addonPath.split(os.pathsep)
  1116. dirName = os.path.dirname(filename)
  1117. if dirName not in addonPath:
  1118. addonPath.append(dirName)
  1119. dlg = wx.MessageDialog(
  1120. self,
  1121. message=_(
  1122. "Directory '%s' is not defined in GRASS_ADDON_PATH. "
  1123. "Do you want add this directory to GRASS_ADDON_PATH?"
  1124. )
  1125. % dirName,
  1126. caption=_("Update Addons path?"),
  1127. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION,
  1128. )
  1129. if dlg.ShowModal() == wx.ID_YES:
  1130. SetAddOnPath(os.pathsep.join(addonPath), key="PATH")
  1131. dlg.Destroy()
  1132. self._gconsole.WriteCmdLog(_("Launching script '%s'...") % filename)
  1133. self._gconsole.RunCmd([filename])
  1134. def OnChangeLocation(self, event):
  1135. """Change current location"""
  1136. dlg = LocationDialog(parent=self)
  1137. gisenv = grass.gisenv()
  1138. if dlg.ShowModal() == wx.ID_OK:
  1139. location, mapset = dlg.GetValues()
  1140. dlg.Destroy()
  1141. if not location or not mapset:
  1142. GError(
  1143. parent=self,
  1144. message=_("No location/mapset provided. Operation canceled."),
  1145. )
  1146. return # this should not happen
  1147. if can_switch_mapset_interactive(
  1148. self, gisenv["GISDBASE"], location, mapset
  1149. ):
  1150. switch_mapset_interactively(self, self._giface, None, location, mapset)
  1151. def OnCreateMapset(self, event):
  1152. """Create new mapset"""
  1153. gisenv = grass.gisenv()
  1154. mapset = create_mapset_interactively(
  1155. self, gisenv["GISDBASE"], gisenv["LOCATION_NAME"]
  1156. )
  1157. if mapset:
  1158. self._giface.grassdbChanged.emit(
  1159. grassdb=gisenv["GISDBASE"],
  1160. location=gisenv["LOCATION_NAME"],
  1161. mapset=mapset,
  1162. action="new",
  1163. element="mapset",
  1164. )
  1165. if can_switch_mapset_interactive(
  1166. self, gisenv["GISDBASE"], gisenv["LOCATION_NAME"], mapset
  1167. ):
  1168. switch_mapset_interactively(
  1169. self, self._giface, None, None, mapset, show_confirmation=True
  1170. )
  1171. def OnChangeMapset(self, event):
  1172. """Change current mapset"""
  1173. dlg = MapsetDialog(parent=self)
  1174. gisenv = grass.gisenv()
  1175. if dlg.ShowModal() == wx.ID_OK:
  1176. mapset = dlg.GetMapset()
  1177. dlg.Destroy()
  1178. if not mapset:
  1179. GError(
  1180. parent=self, message=_("No mapset provided. Operation canceled.")
  1181. )
  1182. return
  1183. if can_switch_mapset_interactive(
  1184. self, gisenv["GISDBASE"], gisenv["LOCATION_NAME"], mapset
  1185. ):
  1186. switch_mapset_interactively(self, self._giface, None, None, mapset)
  1187. def OnMapsetChanged(self, dbase, location, mapset):
  1188. """Current mapset changed.
  1189. If location is None, mapset changed within location.
  1190. """
  1191. if not location:
  1192. self._setTitle()
  1193. else:
  1194. # close current workspace and create new one
  1195. self.OnWorkspaceClose()
  1196. self.OnWorkspaceNew()
  1197. def OnChangeCWD(self, event=None, cmd=None):
  1198. """Change current working directory
  1199. :param event: to be able to serve as a handler of wx event
  1200. :param cmd: command as a list (must start with 'cd')
  1201. """
  1202. # local functions
  1203. def write_beginning(parameter=None, command=None):
  1204. if parameter:
  1205. self._giface.WriteCmdLog('cd "' + parameter + '"')
  1206. else:
  1207. # naive concat but will be enough most of the time
  1208. self._giface.WriteCmdLog(" ".join(command))
  1209. def write_changed():
  1210. self._giface.WriteLog(
  1211. _('Working directory changed to:\n"%s"') % os.getcwd()
  1212. )
  1213. def write_end():
  1214. self._giface.WriteCmdLog(" ")
  1215. def write_help():
  1216. self._giface.WriteLog(
  1217. _("Changes current working directory" " for this GUI.")
  1218. )
  1219. self._giface.WriteLog(_("Usage: cd [directory]"))
  1220. self._giface.WriteLog(_("Without parameters it opens a dialog."))
  1221. # TODO: the following is longer then 80 chars
  1222. # but this should be solved by the function not caller
  1223. # also because of translations
  1224. self._giface.WriteLog(
  1225. _(
  1226. "If ~ (tilde) is present as the first"
  1227. " directory on the path, it is replaced"
  1228. " by user's home directory."
  1229. )
  1230. )
  1231. # check correctness of cmd
  1232. if cmd and cmd[0] != "cd":
  1233. # this is programmer's error
  1234. # can be relaxed in future
  1235. # but keep it strict unless needed otherwise
  1236. raise ValueError(
  1237. "OnChangeCWD cmd parameter must be list of"
  1238. " length 1 or 2 and 'cd' as a first item"
  1239. )
  1240. if cmd and len(cmd) > 2:
  1241. # this might be a user error
  1242. write_beginning(command=cmd)
  1243. self._giface.WriteError(_("More than one parameter provided."))
  1244. write_help()
  1245. write_end()
  1246. return
  1247. # use chdir or dialog
  1248. if cmd and len(cmd) == 2:
  1249. write_beginning(parameter=cmd[1])
  1250. if cmd[1] in ["-h", "--h", "--help", "help"]:
  1251. write_help()
  1252. write_end()
  1253. return
  1254. try:
  1255. path = os.path.expanduser(cmd[1])
  1256. os.chdir(path)
  1257. write_changed()
  1258. except OSError as error:
  1259. self._giface.WriteError(str(error))
  1260. write_end()
  1261. else:
  1262. dlg = wx.DirDialog(
  1263. parent=self,
  1264. message=_("Choose a working directory"),
  1265. defaultPath=os.getcwd(),
  1266. )
  1267. if dlg.ShowModal() == wx.ID_OK:
  1268. self.cwdPath = dlg.GetPath() # is saved in the workspace
  1269. write_beginning(parameter=self.cwdPath)
  1270. os.chdir(self.cwdPath)
  1271. write_changed()
  1272. write_end()
  1273. def GetCwdPath(self):
  1274. """Get current working directory or None"""
  1275. return self.cwdPath
  1276. def OnNewVector(self, event):
  1277. """Create new vector map layer"""
  1278. dlg = CreateNewVector(
  1279. self, giface=self._giface, cmd=(("v.edit", {"tool": "create"}, "map"))
  1280. )
  1281. if not dlg:
  1282. return
  1283. name = dlg.GetName(full=True)
  1284. if name and dlg.IsChecked("add"):
  1285. # add layer to map layer tree
  1286. self.GetLayerTree().AddLayer(
  1287. ltype="vector",
  1288. lname=name,
  1289. lchecked=True,
  1290. lcmd=["d.vect", "map=%s" % name],
  1291. )
  1292. dlg.Destroy()
  1293. def OnSystemInfo(self, event):
  1294. """Print system information"""
  1295. vInfo = grass.version()
  1296. if not vInfo:
  1297. sys.stderr.write(_("Unable to get GRASS version\n"))
  1298. # check also OSGeo4W on MS Windows
  1299. if sys.platform == "win32" and not os.path.exists(
  1300. os.path.join(os.getenv("GISBASE"), "WinGRASS-README.url")
  1301. ):
  1302. osgeo4w = " (OSGeo4W)"
  1303. else:
  1304. osgeo4w = ""
  1305. self._gconsole.WriteCmdLog(_("System Info"))
  1306. # platform decoding was added because of the Fedora 19 release
  1307. # which has the name "Schrödinger’s cat" (umlaut and special ' character)
  1308. # which appears in the platform.platform() string
  1309. platform_ = decode(platform.platform())
  1310. self._gconsole.WriteLog(
  1311. "%s: %s\n" "%s: %s\n" "%s: %s\n" "%s: %s\n"
  1312. # "%s: %s (%s)\n"
  1313. "GDAL: %s\n"
  1314. "PROJ: %s\n"
  1315. "GEOS: %s\n"
  1316. "SQLite: %s\n"
  1317. "Python: %s\n"
  1318. "wxPython: %s\n"
  1319. "%s: %s%s\n"
  1320. % (
  1321. _("GRASS version"),
  1322. vInfo.get("version", _("unknown version")),
  1323. _("Code revision"),
  1324. vInfo.get("revision", "?"),
  1325. _("Build date"),
  1326. vInfo.get("build_date", "?"),
  1327. _("Build platform"),
  1328. vInfo.get("build_platform", "?"),
  1329. # _("GIS Library Revision"),
  1330. # vInfo.get('libgis_revision'],
  1331. # vInfo.get('libgis_date'].split('
  1332. # ', 1)[0],
  1333. vInfo.get("gdal", "?"),
  1334. vInfo.get("proj", "?"),
  1335. vInfo.get("geos", "?"),
  1336. vInfo.get("sqlite", "?"),
  1337. platform.python_version(),
  1338. wx.__version__,
  1339. _("Platform"),
  1340. platform_,
  1341. osgeo4w,
  1342. ),
  1343. notification=Notification.MAKE_VISIBLE,
  1344. )
  1345. self._gconsole.WriteCmdLog(" ")
  1346. def OnAboutGRASS(self, event):
  1347. """Display 'About GRASS' dialog"""
  1348. from gui_core.ghelp import AboutWindow
  1349. win = AboutWindow(self)
  1350. win.CentreOnScreen()
  1351. win.Show(True)
  1352. def _popupMenu(self, data):
  1353. """Create popup menu"""
  1354. menu = Menu()
  1355. for key, handler in data:
  1356. if key is None:
  1357. menu.AppendSeparator()
  1358. continue
  1359. item = wx.MenuItem(menu, wx.ID_ANY, LMIcons[key].GetLabel())
  1360. item.SetBitmap(LMIcons[key].GetBitmap(self.iconsize))
  1361. menu.AppendItem(item)
  1362. self.Bind(wx.EVT_MENU, handler, item)
  1363. # create menu
  1364. self.PopupMenu(menu)
  1365. menu.Destroy()
  1366. def OnWorkspaceNew(self, event=None):
  1367. """Create new workspace file"""
  1368. self.workspace_manager.New()
  1369. def OnWorkspaceOpen(self, event=None):
  1370. """Open file with workspace definition"""
  1371. self.workspace_manager.Open()
  1372. def OnWorkspaceSave(self, event=None):
  1373. """Save file with workspace definition"""
  1374. self.workspace_manager.Save()
  1375. def OnWorkspaceSaveAs(self, event=None):
  1376. """Save workspace definition to selected file"""
  1377. self.workspace_manager.SaveAs()
  1378. def OnWorkspaceClose(self, event=None):
  1379. """Close file with workspace definition"""
  1380. self.workspace_manager.Close()
  1381. def OnDisplayClose(self, event=None):
  1382. """Close current map display window"""
  1383. if self.currentPage and self.GetMapDisplay():
  1384. self.GetMapDisplay().OnCloseWindow(event)
  1385. def OnDisplayCloseAll(self, event):
  1386. """Close all open map display windows (from menu)"""
  1387. if not self.workspace_manager.CanClosePage(caption=_("Close all Map Displays")):
  1388. return
  1389. self.DisplayCloseAll()
  1390. def DisplayCloseAll(self):
  1391. """Close all open map display windows"""
  1392. for display in self.GetMapDisplay(onlyCurrent=False):
  1393. display.OnCloseWindow(event=None, askIfSaveWorkspace=False)
  1394. def OnRenderAllMapDisplays(self, event=None):
  1395. for display in self.GetAllMapDisplays():
  1396. display.OnRender(None)
  1397. def OnRenameDisplay(self, event):
  1398. """Change Map Display name"""
  1399. name = self.notebookLayers.GetPageText(self.currentPageNum)
  1400. dlg = TextEntryDialog(
  1401. self,
  1402. message=_("Enter new name:"),
  1403. caption=_("Rename Map Display"),
  1404. value=name,
  1405. )
  1406. if dlg.ShowModal() == wx.ID_OK:
  1407. name = dlg.GetValue()
  1408. self.notebookLayers.SetPageText(page=self.currentPageNum, text=name)
  1409. self.mapnotebook.SetPageText(page_idx=self.GetMapDisplayIndex(), text=name)
  1410. dlg.Destroy()
  1411. def OnRasterRules(self, event):
  1412. """Launches dialog for raster color rules"""
  1413. from modules.colorrules import RasterColorTable
  1414. ctable = RasterColorTable(self, layerTree=self.GetLayerTree())
  1415. ctable.Show()
  1416. ctable.CentreOnScreen()
  1417. def OnVectorRules(self, event):
  1418. """Launches dialog for vector color rules"""
  1419. from modules.colorrules import VectorColorTable
  1420. ctable = VectorColorTable(
  1421. self, layerTree=self.GetLayerTree(), attributeType="color"
  1422. )
  1423. ctable.Show()
  1424. ctable.CentreOnScreen()
  1425. def OnEditImageryGroups(self, event, cmd=None):
  1426. """Show dialog for creating and editing groups."""
  1427. dlg = GroupDialog(self)
  1428. dlg.CentreOnScreen()
  1429. dlg.Show()
  1430. def OnInstallExtension(self, event):
  1431. """Install extension from GRASS Addons repository"""
  1432. from modules.extensions import InstallExtensionWindow
  1433. win = InstallExtensionWindow(self, giface=self._giface, size=(650, 550))
  1434. win.CentreOnScreen()
  1435. win.Show()
  1436. def OnManageExtension(self, event):
  1437. """Manage or uninstall extensions"""
  1438. from modules.extensions import ManageExtensionWindow
  1439. win = ManageExtensionWindow(self, size=(650, 300))
  1440. win.CentreOnScreen()
  1441. win.Show()
  1442. def OnPreferences(self, event):
  1443. """General GUI preferences/settings"""
  1444. if not self.dialogs["preferences"]:
  1445. dlg = PreferencesDialog(parent=self, giface=self._giface)
  1446. self.dialogs["preferences"] = dlg
  1447. self.dialogs["preferences"].CenterOnParent()
  1448. dlg.settingsChanged.connect(self.OnSettingsChanged)
  1449. self.Bind(
  1450. wx.EVT_CLOSE, lambda evt: self.dialogs.update(preferences=None), dlg
  1451. )
  1452. self.dialogs["preferences"].Show()
  1453. def OnNvizPreferences(self, event):
  1454. """Show nviz preferences"""
  1455. if not self.dialogs["nvizPreferences"]:
  1456. from nviz.preferences import NvizPreferencesDialog
  1457. dlg = NvizPreferencesDialog(parent=self, giface=self._giface)
  1458. self.dialogs["nvizPreferences"] = dlg
  1459. self.dialogs["nvizPreferences"].CenterOnScreen()
  1460. self.dialogs["nvizPreferences"].Show()
  1461. def OnHelp(self, event):
  1462. """Show help"""
  1463. self._gconsole.RunCmd(["g.manual", "-i"])
  1464. def OnIClass(self, event=None, cmd=None):
  1465. """Start wxIClass tool
  1466. The parameters of all handlers which are associated with module
  1467. and contained in menu/toolboxes must be event and cmd.
  1468. When called from menu event is always None and cmd is the
  1469. associated command (list containing a module name and parameters).
  1470. .. todo::
  1471. This documentation is actually documentation of some
  1472. component related to gui_core/menu.py file.
  1473. """
  1474. from iclass.frame import IClassMapDisplay, haveIClass, errMsg
  1475. if not haveIClass:
  1476. GError(
  1477. _('Unable to launch "Supervised Classification Tool".\n\n' "Reason: %s")
  1478. % errMsg
  1479. )
  1480. return
  1481. frame = wx.Frame(
  1482. parent=None,
  1483. size=globalvar.MAP_WINDOW_SIZE,
  1484. title=_("Supervised Classification Tool"),
  1485. )
  1486. win = IClassMapDisplay(parent=frame, giface=self._giface)
  1487. win.CentreOnScreen()
  1488. win.Show()
  1489. def OnAnimationTool(self, event=None, cmd=None):
  1490. """Launch Animation tool. See OnIClass documentation."""
  1491. from animation.frame import AnimationFrame
  1492. frame = AnimationFrame(parent=self, giface=self._giface)
  1493. frame.CentreOnScreen()
  1494. frame.Show()
  1495. tree = self.GetLayerTree()
  1496. if tree:
  1497. rasters = []
  1498. for layer in tree.GetSelectedLayers(checkedOnly=False):
  1499. if tree.GetLayerInfo(layer, key="type") == "raster":
  1500. rasters.append(tree.GetLayerInfo(layer, key="maplayer").GetName())
  1501. if len(rasters) >= 2:
  1502. from core.layerlist import LayerList
  1503. from animation.data import AnimLayer
  1504. layerList = LayerList()
  1505. layer = AnimLayer()
  1506. layer.mapType = "raster"
  1507. layer.name = ",".join(rasters)
  1508. layer.cmd = ["d.rast", "map="]
  1509. layerList.AddLayer(layer)
  1510. frame.SetAnimations([layerList, None, None, None])
  1511. def OnTimelineTool(self, event=None, cmd=None):
  1512. """Launch Timeline Tool"""
  1513. try:
  1514. from timeline.frame import TimelineFrame
  1515. except ImportError:
  1516. GError(parent=self, message=_("Unable to start Timeline Tool."))
  1517. return
  1518. frame = TimelineFrame(None)
  1519. frame.Show()
  1520. def OnTplotTool(self, event=None, cmd=None):
  1521. """Launch Temporal Plot Tool"""
  1522. try:
  1523. from tplot.frame import TplotFrame
  1524. except ImportError:
  1525. GError(parent=self, message=_("Unable to start Temporal Plot Tool."))
  1526. return
  1527. frame = TplotFrame(parent=self, giface=self._giface)
  1528. frame.Show()
  1529. def OnHistogram(self, event):
  1530. """Init histogram display canvas and tools"""
  1531. from modules.histogram import HistogramFrame
  1532. win = HistogramFrame(self, giface=self._giface)
  1533. win.CentreOnScreen()
  1534. win.Show()
  1535. win.Refresh()
  1536. win.Update()
  1537. def OnMapCalculator(self, event, cmd=""):
  1538. """Init map calculator for interactive creation of mapcalc statements"""
  1539. from modules.mcalc_builder import MapCalcFrame
  1540. if event:
  1541. try:
  1542. cmd = self.GetMenuCmd(event)
  1543. except KeyError:
  1544. cmd = ["r.mapcalc"]
  1545. win = MapCalcFrame(parent=self, giface=self._giface, cmd=cmd[0])
  1546. win.CentreOnScreen()
  1547. win.Show()
  1548. def OnVectorCleaning(self, event, cmd=""):
  1549. """Init interactive vector cleaning"""
  1550. from modules.vclean import VectorCleaningFrame
  1551. win = VectorCleaningFrame(parent=self)
  1552. win.CentreOnScreen()
  1553. win.Show()
  1554. def OnRasterOutputFormat(self, event):
  1555. """Set raster output format handler"""
  1556. self.OnMenuCmd(cmd=["r.external.out"])
  1557. def OnVectorOutputFormat(self, event):
  1558. """Set vector output format handler"""
  1559. from modules.import_export import GdalOutputDialog
  1560. dlg = GdalOutputDialog(parent=self, ogr=True)
  1561. dlg.CentreOnScreen()
  1562. dlg.Show()
  1563. def OnImportDxfFile(self, event, cmd=None):
  1564. """Convert multiple DXF layers to GRASS vector map layers"""
  1565. from modules.import_export import DxfImportDialog
  1566. dlg = DxfImportDialog(parent=self, giface=self._giface)
  1567. dlg.CentreOnScreen()
  1568. dlg.Show()
  1569. def OnImportGdalLayers(self, event, cmd=None):
  1570. """Convert multiple GDAL layers to GRASS raster map layers"""
  1571. from modules.import_export import GdalImportDialog
  1572. dlg = GdalImportDialog(parent=self, giface=self._giface)
  1573. dlg.CentreOnScreen()
  1574. dlg.Show()
  1575. def OnLinkGdalLayers(self, event, cmd=None):
  1576. """Link multiple GDAL layers to GRASS raster map layers"""
  1577. from modules.import_export import GdalImportDialog
  1578. dlg = GdalImportDialog(parent=self, giface=self._giface, link=True)
  1579. dlg.CentreOnScreen()
  1580. dlg.Show()
  1581. def OnImportOgrLayers(self, event, cmd=None):
  1582. """Convert multiple OGR layers to GRASS vector map layers"""
  1583. from modules.import_export import OgrImportDialog
  1584. dlg = OgrImportDialog(parent=self, giface=self._giface)
  1585. dlg.CentreOnScreen()
  1586. dlg.Show()
  1587. def OnLinkOgrLayers(self, event, cmd=None):
  1588. """Links multiple OGR layers to GRASS vector map layers"""
  1589. from modules.import_export import OgrImportDialog
  1590. dlg = OgrImportDialog(parent=self, giface=self._giface, link=True)
  1591. dlg.CentreOnScreen()
  1592. dlg.Show()
  1593. def OnAddWS(self, event, cmd=None):
  1594. """Add web services layer"""
  1595. from web_services.dialogs import AddWSDialog
  1596. dlg = AddWSDialog(parent=self, giface=self._giface)
  1597. dlg.CentreOnScreen()
  1598. x, y = dlg.GetPosition()
  1599. dlg.SetPosition((x, y - 200))
  1600. dlg.Show()
  1601. def OnSimpleEditor(self, event):
  1602. # import on demand
  1603. from gui_core.pyedit import PyEditFrame
  1604. # we don't keep track of them and we don't care about open files
  1605. # there when closing the main GUI
  1606. simpleEditor = PyEditFrame(parent=self, giface=self._giface)
  1607. simpleEditor.SetSize(self.GetSize())
  1608. simpleEditor.CenterOnScreen()
  1609. simpleEditor.Show()
  1610. def OnShowAttributeTable(self, event, selection=None):
  1611. """Show attribute table of the given vector map layer"""
  1612. if not self.currentPage:
  1613. self.MsgNoLayerSelected()
  1614. return
  1615. tree = self.GetLayerTree()
  1616. layer = tree.layer_selected
  1617. # no map layer selected
  1618. if not layer:
  1619. self.MsgNoLayerSelected()
  1620. return
  1621. # available only for vector map layers
  1622. try:
  1623. maptype = tree.GetLayerInfo(layer, key="maplayer").type
  1624. except Exception:
  1625. maptype = None
  1626. if not maptype or maptype != "vector":
  1627. GMessage(parent=self, message=_("Selected map layer is not vector."))
  1628. return
  1629. if not tree.GetLayerInfo(layer):
  1630. return
  1631. dcmd = tree.GetLayerInfo(layer, key="cmd")
  1632. if not dcmd:
  1633. return
  1634. from dbmgr.manager import AttributeManager
  1635. dbmanager = AttributeManager(
  1636. parent=self,
  1637. id=wx.ID_ANY,
  1638. size=wx.Size(500, 300),
  1639. item=layer,
  1640. log=self._gconsole,
  1641. selection=selection,
  1642. )
  1643. # register ATM dialog
  1644. self.dialogs["atm"].append(dbmanager)
  1645. # show ATM window
  1646. dbmanager.Show()
  1647. def _onMapDisplayFocus(self, notebookLayerPage):
  1648. """Changes bookcontrol page to page associated with display."""
  1649. # moved from mapdisp/frame.py
  1650. # TODO: why it is called 3 times when getting focus?
  1651. # and one times when loosing focus?
  1652. if self.workspace_manager.loadingWorkspace:
  1653. return
  1654. pgnum = self.notebookLayers.GetPageIndex(notebookLayerPage)
  1655. if pgnum > -1:
  1656. self.notebookLayers.SetSelection(pgnum)
  1657. self.currentPage = self.notebookLayers.GetCurrentPage()
  1658. def _onStarting3dMode(self, mapDisplayPage):
  1659. """Disables 3D mode for all map displays except for @p mapDisplay"""
  1660. # TODO: it should be disabled also for newly created map windows
  1661. # moreover mapdisp.Disable3dMode() does not work properly
  1662. for page in range(0, self.GetLayerNotebook().GetPageCount()):
  1663. mapdisp = self.GetLayerNotebook().GetPage(page).maptree.GetMapDisplay()
  1664. if self.GetLayerNotebook().GetPage(page) != mapDisplayPage:
  1665. mapdisp.Disable3dMode()
  1666. def OnAddMaps(self, event=None):
  1667. """Add selected map layers into layer tree"""
  1668. dialog = MapLayersDialog(
  1669. parent=self, title=_("Add selected map layers into layer tree")
  1670. )
  1671. dialog.applyAddingMapLayers.connect(self.AddMaps)
  1672. val = dialog.ShowModal()
  1673. if val == wx.ID_OK:
  1674. self.AddMaps(dialog.GetMapLayers(), dialog.GetLayerType(cmd=True))
  1675. dialog.Destroy()
  1676. def AddMaps(self, mapLayers, ltype, check=False):
  1677. """Add map layers to layer tree.
  1678. :param list mapLayers: list of map names
  1679. :param str ltype: layer type ('raster', 'raster_3d', 'vector')
  1680. :param bool check: True if new layers should be checked in
  1681. layer tree False otherwise
  1682. """
  1683. # start new map display if no display is available
  1684. if not self.currentPage:
  1685. self.NewDisplay()
  1686. maptree = self.GetLayerTree()
  1687. for layerName in mapLayers:
  1688. if ltype == "raster":
  1689. cmd = ["d.rast", "map=%s" % layerName]
  1690. elif ltype == "raster_3d":
  1691. cmd = ["d.rast3d", "map=%s" % layerName]
  1692. elif ltype == "vector":
  1693. cmd = ["d.vect", "map=%s" % layerName] + GetDisplayVectSettings()
  1694. else:
  1695. GError(
  1696. parent=self, message=_("Unsupported map layer type <%s>.") % ltype
  1697. )
  1698. return
  1699. maptree.AddLayer(
  1700. ltype=ltype,
  1701. lname=layerName,
  1702. lchecked=check,
  1703. lopacity=1.0,
  1704. lcmd=cmd,
  1705. lgroup=None,
  1706. )
  1707. def _updateCurrentMap(self, **kwargs):
  1708. """Updates map of the current map window."""
  1709. if "delay" in kwargs:
  1710. self.GetMapDisplay().GetWindow().UpdateMap(delay=kwargs["delay"])
  1711. else:
  1712. self.GetMapDisplay().GetWindow().UpdateMap()
  1713. def OnMapCreated(self, name, ltype, add=None):
  1714. """Decides whether the map should be added to layer tree."""
  1715. if add is None:
  1716. # add new map into layer if globally enabled
  1717. if UserSettings.Get(group="cmd", key="addNewLayer", subkey="enabled"):
  1718. self.AddOrUpdateMap(name, ltype)
  1719. elif add:
  1720. # add new map into layer tree
  1721. self.AddOrUpdateMap(name, ltype)
  1722. else:
  1723. # update the map
  1724. display = self.GetMapDisplay()
  1725. display.GetWindow().UpdateMap(render=True)
  1726. def AddOrUpdateMap(self, mapName, ltype):
  1727. """Add map layer or update"""
  1728. # start new map display if no display is available
  1729. if ltype not in ["raster", "raster_3d", "vector"]:
  1730. GError(parent=self, message=_("Unsupported map layer type <%s>.") % ltype)
  1731. return
  1732. if not self.currentPage:
  1733. self.AddMaps([mapName], ltype, check=True)
  1734. else:
  1735. display = self.GetMapDisplay()
  1736. mapLayers = map(
  1737. lambda x: x.GetName(), display.GetMap().GetListOfLayers(ltype=ltype)
  1738. )
  1739. if mapName in mapLayers:
  1740. display.GetWindow().UpdateMap(render=True)
  1741. else:
  1742. self.AddMaps([mapName], ltype, check=True)
  1743. def OnAddRaster(self, event):
  1744. """Add raster map layer"""
  1745. # start new map display if no display is available
  1746. if not self.currentPage:
  1747. self.NewDisplay(show=True)
  1748. self.GetLayerTree().AddLayer("raster")
  1749. def OnAddRasterMisc(self, event):
  1750. """Create misc raster popup-menu"""
  1751. # start new map display if no display is available
  1752. if not self.currentPage:
  1753. self.NewDisplay(show=True)
  1754. self._popupMenu(
  1755. (
  1756. ("layerRaster_3d", self.OnAddRaster3D),
  1757. (None, None),
  1758. ("layerRgb", self.OnAddRasterRGB),
  1759. ("layerHis", self.OnAddRasterHIS),
  1760. (None, None),
  1761. ("layerShaded", self.OnAddRasterShaded),
  1762. (None, None),
  1763. ("layerRastarrow", self.OnAddRasterArrow),
  1764. ("layerRastnum", self.OnAddRasterNum),
  1765. )
  1766. )
  1767. def OnAddVector(self, event):
  1768. """Add vector map to the current layer tree"""
  1769. # start new map display if no display is available
  1770. if not self.currentPage:
  1771. self.NewDisplay(show=True)
  1772. self.GetLayerTree().AddLayer("vector")
  1773. def OnAddVectorMisc(self, event):
  1774. """Create misc vector popup-menu"""
  1775. # start new map display if no display is available
  1776. if not self.currentPage:
  1777. self.NewDisplay(show=True)
  1778. self._popupMenu(
  1779. (
  1780. ("layerThememap", self.OnAddVectorTheme),
  1781. ("layerThemechart", self.OnAddVectorChart),
  1782. )
  1783. )
  1784. def OnAddVectorTheme(self, event):
  1785. """Add thematic vector map to the current layer tree"""
  1786. self.GetLayerTree().AddLayer("thememap")
  1787. def OnAddVectorChart(self, event):
  1788. """Add chart vector map to the current layer tree"""
  1789. self.GetLayerTree().AddLayer("themechart")
  1790. def OnAddOverlay(self, event):
  1791. """Create decoration overlay menu"""
  1792. # start new map display if no display is available
  1793. if not self.currentPage:
  1794. self.NewDisplay(show=True)
  1795. self._popupMenu(
  1796. (
  1797. ("layerGrid", self.OnAddGrid),
  1798. ("layerLabels", self.OnAddLabels),
  1799. ("layerGeodesic", self.OnAddGeodesic),
  1800. ("layerRhumb", self.OnAddRhumb),
  1801. (None, None),
  1802. ("layerCmd", self.OnAddCommand),
  1803. )
  1804. )
  1805. def OnAddRaster3D(self, event):
  1806. """Add 3D raster map to the current layer tree"""
  1807. self.GetLayerTree().AddLayer("raster_3d")
  1808. def OnAddRasterRGB(self, event):
  1809. """Add RGB raster map to the current layer tree"""
  1810. self.GetLayerTree().AddLayer("rgb")
  1811. def OnAddRasterHIS(self, event):
  1812. """Add HIS raster map to the current layer tree"""
  1813. self.GetLayerTree().AddLayer("his")
  1814. def OnAddRasterShaded(self, event):
  1815. """Add shaded relief raster map to the current layer tree"""
  1816. self.GetLayerTree().AddLayer("shaded")
  1817. def OnAddRasterArrow(self, event):
  1818. """Add flow arrows raster map to the current layer tree"""
  1819. # here it seems that it should be retrieved from the mapwindow
  1820. mapdisplay = self.GetMapDisplay()
  1821. resolution = mapdisplay.mapWindowProperties.resolution
  1822. if not resolution:
  1823. dlg = self.MsgDisplayResolution()
  1824. if dlg.ShowModal() == wx.ID_YES:
  1825. mapdisplay.mapWindowProperties.resolution = True
  1826. dlg.Destroy()
  1827. self.GetLayerTree().AddLayer("rastarrow")
  1828. def OnAddRasterNum(self, event):
  1829. """Add cell number raster map to the current layer tree"""
  1830. mapdisplay = self.GetMapDisplay()
  1831. resolution = mapdisplay.mapWindowProperties.resolution
  1832. if not resolution:
  1833. limitText = _(
  1834. "Note that cell values can only be displayed for "
  1835. "regions of less than 10,000 cells."
  1836. )
  1837. dlg = self.MsgDisplayResolution(limitText)
  1838. if dlg.ShowModal() == wx.ID_YES:
  1839. mapdisplay.mapWindowProperties.resolution = True
  1840. dlg.Destroy()
  1841. # region = tree.GetMap().GetCurrentRegion()
  1842. # if region['cells'] > 10000:
  1843. # GMessage(message = "Cell values can only be displayed
  1844. # for regions of < 10,000 cells.", parent = self)
  1845. self.GetLayerTree().AddLayer("rastnum")
  1846. def OnAddCommand(self, event):
  1847. """Add command line map layer to the current layer tree"""
  1848. # start new map display if no display is available
  1849. if not self.currentPage:
  1850. self.NewDisplay(show=True)
  1851. self.GetLayerTree().AddLayer("command")
  1852. def OnAddGroup(self, event):
  1853. """Add layer group"""
  1854. # start new map display if no display is available
  1855. if not self.currentPage:
  1856. self.NewDisplay(show=True)
  1857. self.GetLayerTree().AddLayer("group")
  1858. def OnAddGrid(self, event):
  1859. """Add grid map layer to the current layer tree"""
  1860. self.GetLayerTree().AddLayer("grid")
  1861. def OnAddGeodesic(self, event):
  1862. """Add geodesic line map layer to the current layer tree"""
  1863. self.GetLayerTree().AddLayer("geodesic")
  1864. def OnAddRhumb(self, event):
  1865. """Add rhumb map layer to the current layer tree"""
  1866. self.GetLayerTree().AddLayer("rhumb")
  1867. def OnAddLabels(self, event):
  1868. """Add vector labels map layer to the current layer tree"""
  1869. # start new map display if no display is available
  1870. if not self.currentPage:
  1871. self.NewDisplay(show=True)
  1872. self.GetLayerTree().AddLayer("labels")
  1873. def OnShowRegionExtent(self, event):
  1874. """Add vector labels map layer to the current layer tree"""
  1875. # start new map display if no display is available
  1876. if not self.currentPage:
  1877. self.NewDisplay(show=True)
  1878. # get current map display
  1879. mapdisp = self.GetMapDisplay()
  1880. # change the property
  1881. mapdisp.mapWindowProperties.showRegion = True
  1882. # show map display (user said show so make sure it is visible)
  1883. mapdisp.Show()
  1884. # redraw map if auto-rendering is enabled
  1885. # seems little too low level for this place
  1886. # no redraw when Render is unchecked
  1887. if mapdisp.IsAutoRendered():
  1888. mapdisp.GetMapWindow().UpdateMap(render=False)
  1889. def OnDeleteLayer(self, event):
  1890. """Remove selected map layer from the current layer Tree"""
  1891. if not self.currentPage or not self.GetLayerTree().layer_selected:
  1892. self.MsgNoLayerSelected()
  1893. return
  1894. if UserSettings.Get(group="manager", key="askOnRemoveLayer", subkey="enabled"):
  1895. layerName = ""
  1896. for item in self.GetLayerTree().GetSelections():
  1897. name = self.GetLayerTree().GetItemText(item)
  1898. idx = name.find("(" + _("opacity:"))
  1899. if idx > -1:
  1900. layerName += "<" + name[:idx].strip(" ") + ">,\n"
  1901. else:
  1902. layerName += "<" + name + ">,\n"
  1903. layerName = layerName.rstrip(",\n")
  1904. if len(layerName) > 2: # <>
  1905. message = (
  1906. _("Do you want to remove map layer(s)\n%s\n" "from layer tree?")
  1907. % layerName
  1908. )
  1909. else:
  1910. message = _(
  1911. "Do you want to remove selected map layer(s) " "from layer tree?"
  1912. )
  1913. dlg = wx.MessageDialog(
  1914. parent=self,
  1915. message=message,
  1916. caption=_("Remove map layer"),
  1917. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION,
  1918. )
  1919. if dlg.ShowModal() != wx.ID_YES:
  1920. dlg.Destroy()
  1921. return
  1922. dlg.Destroy()
  1923. for layer in self.GetLayerTree().GetSelections():
  1924. if self.GetLayerTree().GetLayerInfo(layer, key="type") == "group":
  1925. self.GetLayerTree().DeleteChildren(layer)
  1926. # nested children group layer in the parent group layer (both selected)
  1927. try:
  1928. self.GetLayerTree().Delete(layer)
  1929. except ValueError:
  1930. pass
  1931. def OnKeyDown(self, event):
  1932. """Key pressed"""
  1933. kc = event.GetKeyCode()
  1934. try:
  1935. kc = chr(kc)
  1936. except ValueError:
  1937. event.Skip()
  1938. return
  1939. if event.CtrlDown():
  1940. if kc == "R":
  1941. self.OnAddRaster(None)
  1942. elif kc == "V":
  1943. self.OnAddVector(None)
  1944. event.Skip()
  1945. def OnCloseWindow(self, event):
  1946. """Cleanup when wxGUI is quitted"""
  1947. self._closeWindow(event)
  1948. def OnCloseWindowOrExit(self, event):
  1949. """Cleanup when wxGUI is quitted
  1950. Ask user also to quit GRASS including terminal
  1951. """
  1952. dlg = QuitDialog(self)
  1953. ret = dlg.ShowModal()
  1954. dlg.Destroy()
  1955. if ret != wx.ID_CANCEL:
  1956. self._closeWindow(event)
  1957. if ret == wx.ID_YES:
  1958. self._quitGRASS()
  1959. def _closeWindow(self, event):
  1960. """Close wxGUI"""
  1961. # save command protocol if actived
  1962. if self.goutput.btnCmdProtocol.GetValue():
  1963. self.goutput.CmdProtocolSave()
  1964. if not self.currentPage:
  1965. self._auimgr.UnInit()
  1966. self.Destroy()
  1967. return
  1968. if not self.workspace_manager.CanClosePage(caption=_("Quit GRASS GUI")):
  1969. # when called from menu, it gets CommandEvent and not
  1970. # CloseEvent
  1971. if hasattr(event, "Veto"):
  1972. event.Veto()
  1973. return
  1974. self.DisplayCloseAll()
  1975. self._auimgr.UnInit()
  1976. self.Destroy()
  1977. def _quitGRASS(self):
  1978. """Quit GRASS terminal"""
  1979. shellPid = get_shell_pid()
  1980. if shellPid is None:
  1981. return
  1982. Debug.msg(1, "Exiting shell with pid={0}".format(shellPid))
  1983. import signal
  1984. os.kill(shellPid, signal.SIGTERM)
  1985. def MsgNoLayerSelected(self):
  1986. """Show dialog message 'No layer selected'"""
  1987. wx.MessageBox(
  1988. parent=self,
  1989. message=_("No map layer selected. Operation canceled."),
  1990. caption=_("Message"),
  1991. style=wx.OK | wx.ICON_INFORMATION | wx.CENTRE,
  1992. )
  1993. def MsgDisplayResolution(self, limitText=None):
  1994. """Returns dialog for d.rast.num, d.rast.arrow
  1995. when display resolution is not constrained
  1996. :param limitText: adds a note about cell limit
  1997. """
  1998. message = _(
  1999. "Display resolution is currently not constrained to "
  2000. "computational settings. "
  2001. "It's suggested to constrain map to region geometry. "
  2002. "Do you want to constrain "
  2003. "the resolution?"
  2004. )
  2005. if limitText:
  2006. message += "\n\n%s" % _(limitText)
  2007. dlg = wx.MessageDialog(
  2008. parent=self,
  2009. message=message,
  2010. caption=_("Constrain map to region geometry?"),
  2011. style=wx.YES_NO | wx.YES_DEFAULT | wx.ICON_QUESTION | wx.CENTRE,
  2012. )
  2013. return dlg
  2014. def OnMapNotebookClose(self, event):
  2015. """Page of map notebook is being closed"""
  2016. display = self.GetMapDisplay(onlyCurrent=True)
  2017. display.OnCloseWindow(event=None, askIfSaveWorkspace=True)
  2018. event.Veto()