GRASS Programmer's Manual  6.5.svn(2012)-r51648
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
frame.GMFrame Class Reference

Layer Manager frame with notebook widget for controlling GRASS GIS. More...

Public Member Functions

def __init__
def IsPaneShown
 Check if pane (toolbar, ...) of given name is currently shown.
def AddNvizTools
 Add nviz notebook page.
def RemoveNvizTools
 Remove nviz notebook page.
def WorkspaceChanged
 Update window title.
def OnLocationWizard
 Launch location wizard.
def OnSettingsChanged
 Here can be functions which have to be called after EVT_SETTINGS_CHANGED.
def OnGCPManager
 Launch georectifier module.
def OnGModeler
 Launch Graphical Modeler.
def OnPsMap
 Launch Cartographic Composer.
def OnDone
def OnRunModel
 Run model.
def OnMapsets
 Launch mapset access dialog.
def OnCBPageChanged
 Page in notebook (display) changed.
def OnPageChanged
 Page in notebook changed.
def OnCBPageClosed
 Page of notebook closed Also close associated map display.
def GetLayerTree
 Get current layer tree.
def GetLogWindow
 Get widget for command output.
def GetMenuCmd
 Get GRASS command from menu item.
def RunMenuCmd
 Run command selected from menu.
def OnMenuCmd
 Parse command selected from menu.
def OnVDigit
 Start vector digitizer.
def OnRunScript
 Run script.
def OnChangeLocation
def OnCreateMapset
 Create new mapset.
def OnChangeMapset
def OnNewVector
 Create new vector map layer.
def OnAboutGRASS
 Display 'About GRASS' dialog.
def OnImportMenu
 Import maps menu (import, link)
def OnWorkspaceNew
 Create new workspace file.
def OnWorkspaceOpen
 Open file with workspace definition.
def LoadWorkspaceFile
 Load layer tree definition stored in GRASS Workspace XML file (gxw)
def OnWorkspaceLoadGrcFile
 Load map layers from GRC file (Tcl/Tk GUI) into map layer tree.
def OnWorkspaceSaveAs
 Save workspace definition to selected file.
def OnWorkspaceSave
 Save file with workspace definition.
def SaveToWorkspaceFile
 Save layer tree layout to workspace file.
def OnWorkspaceClose
 Close file with workspace definition.
def OnDisplayClose
 Close current map display window.
def OnDisplayCloseAll
 Close all open map display windows.
def OnRenameDisplay
 Change Map Display name.
def RulesCmd
 Launches dialog for commands that need rules input and processes rules.
def OnXTermNoXMon
 Run commands that need xterm.
def OnXTerm
 Run commands that need interactive xmon.
def OnEditImageryGroups
 Show dialog for creating and editing groups.
def OnInstallExtension
 Install extension from GRASS Addons SVN repository.
def OnUninstallExtension
 Uninstall extension.
def OnPreferences
 General GUI preferences/settings.
def OnHelp
 Show help.
def OnHistogram
 Init histogram display canvas and tools.
def OnProfile
 Launch profile tool.
def OnMapCalculator
 Init map calculator for interactive creation of mapcalc statements.
def OnVectorCleaning
 Init interactive vector cleaning.
def OnImportDxfFile
 Convert multiple DXF layers to GRASS vector map layers.
def OnImportGdalLayers
 Convert multiple GDAL layers to GRASS raster map layers.
def OnLinkGdalLayers
 Link multiple GDAL layers to GRASS raster map layers.
def OnImportOgrLayers
 Convert multiple OGR layers to GRASS vector map layers.
def OnLinkOgrLayers
 Links multiple OGR layers to GRASS vector map layers.
def OnImportWMS
 Import data from OGC WMS server.
def OnShowAttributeTable
 Show attribute table of the given vector map layer.
def OnNewDisplayWMS
 Create new layer tree and map display instance.
def OnNewDisplay
 Create new layer tree and map display instance.
def NewDisplay
 Create new layer tree, which will create an associated map display frame.
def OnAddMaps
 Add selected map layers into layer tree.
def OnAddRaster
 Add raster map layer.
def OnAddRaster3D
 Add 3D raster map layer.
def OnAddRasterMisc
 Create misc raster popup-menu.
def OnAddVector
 Add vector map to the current layer tree.
def OnAddVectorMisc
 Create misc vector popup-menu.
def OnAddVectorTheme
 Add thematic vector map to the current layer tree.
def OnAddVectorChart
 Add chart vector map to the current layer tree.
def OnAddOverlay
 Create decoration overlay menu.
def OnAddRaster3D
 Add 3D raster map to the current layer tree.
def OnAddRasterRGB
 Add RGB raster map to the current layer tree.
def OnAddRasterHIS
 Add HIS raster map to the current layer tree.
def OnAddRasterShaded
 Add shaded relief raster map to the current layer tree.
def OnAddRasterArrow
 Add flow arrows raster map to the current layer tree.
def OnAddRasterNum
 Add cell number raster map to the current layer tree.
def OnAddCommand
 Add command line map layer to the current layer tree.
def OnAddGroup
 Add layer group.
def OnAddGrid
 Add grid map layer to the current layer tree.
def OnAddGeodesic
 Add geodesic line map layer to the current layer tree.
def OnAddRhumb
 Add rhumb map layer to the current layer tree.
def OnAddLabels
 Add vector labels map layer to the current layer tree.
def OnDeleteLayer
 Remove selected map layer from the current layer Tree.
def OnKeyDown
 Key pressed.
def OnCloseWindow
 Cleanup when wxGUI is quitted.
def MsgNoLayerSelected
 Show dialog message 'No layer selected'.

Data Fields

 parent
 baseTitle
 iconsize
 disp_idx
 curr_page
 curr_pagenum
 workspaceFile
 workspaceChanged
 georectifying
 gcpmanagement
 dialogs
 statusbar
 notebook
 toolbars
 menubar
 menucmd
 gm_cb
 goutput
 search
 pyshell
 nviz
 model
 pg_panel

Detailed Description

Layer Manager frame with notebook widget for controlling GRASS GIS.

Includes command console page for typing GRASS (and other) commands, tree widget page for managing map layers.

Definition at line 69 of file lmgr/frame.py.


Constructor & Destructor Documentation

def frame.GMFrame.__init__ (   self,
  parent,
  id = wx.ID_ANY,
  title = _("GRASS GIS Layer Manager"),
  workspace = None,
  size = globalvar.GM_WINDOW_SIZE,
  style = wx.DEFAULT_FRAME_STYLE,
  kwargs 
)

Definition at line 76 of file lmgr/frame.py.


Member Function Documentation

Add nviz notebook page.

Definition at line 282 of file lmgr/frame.py.

Get current layer tree.

Definition at line 483 of file lmgr/frame.py.

Referenced by frame.GMFrame.OnShowAttributeTable(), and frame.GMFrame.OnVDigit().

Get widget for command output.

Definition at line 487 of file lmgr/frame.py.

References frame.ModelFrame.goutput, frame.GMFrame.goutput, forms.TaskFrame.goutput, and forms.CmdPanel.goutput.

def frame.GMFrame.GetMenuCmd (   self,
  event 
)

Get GRASS command from menu item.

Return command as a list

Definition at line 491 of file lmgr/frame.py.

References menu.Menu.menucmd, and frame.GMFrame.menucmd.

Referenced by frame.GMFrame.OnMapCalculator(), frame.GMFrame.OnMenuCmd(), frame.GMFrame.OnXTerm(), frame.GMFrame.RulesCmd(), and frame.GMFrame.RunMenuCmd().

def frame.GMFrame.LoadWorkspaceFile (   self,
  filename 
)

Load layer tree definition stored in GRASS Workspace XML file (gxw)

Todo:
Validate against DTD
Returns:
True on success
False on error

Definition at line 817 of file lmgr/frame.py.

References frame.GMFrame.NewDisplay().

Referenced by frame.GMFrame.OnWorkspaceOpen().

Show dialog message 'No layer selected'.

Definition at line 1739 of file lmgr/frame.py.

Referenced by frame.GMFrame.OnDeleteLayer(), frame.GMFrame.OnShowAttributeTable(), and frame.GMFrame.OnVDigit().

def frame.GMFrame.NewDisplay (   self,
  name = None,
  show = True 
)
def frame.GMFrame.OnAboutGRASS (   self,
  event 
)

Display 'About GRASS' dialog.

Definition at line 720 of file lmgr/frame.py.

References mapdisp.MapFrameBase.iconsize, and frame.GMFrame.iconsize.

def frame.GMFrame.OnAddCommand (   self,
  event 
)

Add command line map layer to the current layer tree.

Definition at line 1576 of file lmgr/frame.py.

References frame.GMFrame.curr_page, and frame.GMFrame.NewDisplay().

Referenced by frame.GMFrame.OnAddOverlay().

def frame.GMFrame.OnAddGeodesic (   self,
  event 
)

Add geodesic line map layer to the current layer tree.

Definition at line 1605 of file lmgr/frame.py.

Referenced by frame.GMFrame.OnAddOverlay().

def frame.GMFrame.OnAddGrid (   self,
  event 
)

Add grid map layer to the current layer tree.

Definition at line 1600 of file lmgr/frame.py.

Referenced by frame.GMFrame.OnAddOverlay().

def frame.GMFrame.OnAddGroup (   self,
  event 
)

Add layer group.

Definition at line 1588 of file lmgr/frame.py.

References frame.GMFrame.curr_page, and frame.GMFrame.NewDisplay().

def frame.GMFrame.OnAddLabels (   self,
  event 
)

Add vector labels map layer to the current layer tree.

Definition at line 1615 of file lmgr/frame.py.

References frame.GMFrame.curr_page, and frame.GMFrame.NewDisplay().

Referenced by frame.GMFrame.OnAddOverlay().

def frame.GMFrame.OnAddMaps (   self,
  event = None 
)

Add selected map layers into layer tree.

Definition at line 1425 of file lmgr/frame.py.

References frame.GMFrame.curr_page, and frame.GMFrame.NewDisplay().

def frame.GMFrame.OnAddRaster (   self,
  event 
)

Add raster map layer.

Definition at line 1463 of file lmgr/frame.py.

References frame.GMFrame.curr_page, and frame.GMFrame.NewDisplay().

Referenced by frame.GMFrame.OnKeyDown().

def frame.GMFrame.OnAddRaster3D (   self,
  event 
)

Add 3D raster map layer.

Definition at line 1472 of file lmgr/frame.py.

References frame.GMFrame.curr_page, and frame.GMFrame.NewDisplay().

Referenced by frame.GMFrame.OnAddRaster3D(), and frame.GMFrame.OnAddRasterMisc().

def frame.GMFrame.OnAddRaster3D (   self,
  event 
)

Add 3D raster map to the current layer tree.

Definition at line 1546 of file lmgr/frame.py.

References frame.GMFrame.OnAddRaster3D().

def frame.GMFrame.OnAddRasterArrow (   self,
  event 
)

Add flow arrows raster map to the current layer tree.

Definition at line 1566 of file lmgr/frame.py.

Referenced by frame.GMFrame.OnAddRasterMisc().

def frame.GMFrame.OnAddRasterHIS (   self,
  event 
)

Add HIS raster map to the current layer tree.

Definition at line 1556 of file lmgr/frame.py.

Referenced by frame.GMFrame.OnAddRasterMisc().

def frame.GMFrame.OnAddRasterNum (   self,
  event 
)

Add cell number raster map to the current layer tree.

Definition at line 1571 of file lmgr/frame.py.

Referenced by frame.GMFrame.OnAddRasterMisc().

def frame.GMFrame.OnAddRasterRGB (   self,
  event 
)

Add RGB raster map to the current layer tree.

Definition at line 1551 of file lmgr/frame.py.

Referenced by frame.GMFrame.OnAddRasterMisc().

def frame.GMFrame.OnAddRasterShaded (   self,
  event 
)

Add shaded relief raster map to the current layer tree.

Definition at line 1561 of file lmgr/frame.py.

Referenced by frame.GMFrame.OnAddRasterMisc().

def frame.GMFrame.OnAddRhumb (   self,
  event 
)

Add rhumb map layer to the current layer tree.

Definition at line 1610 of file lmgr/frame.py.

Referenced by frame.GMFrame.OnAddOverlay().

def frame.GMFrame.OnAddVector (   self,
  event 
)

Add vector map to the current layer tree.

Definition at line 1499 of file lmgr/frame.py.

References frame.GMFrame.curr_page, and frame.GMFrame.NewDisplay().

Referenced by frame.GMFrame.OnKeyDown().

def frame.GMFrame.OnAddVectorChart (   self,
  event 
)

Add chart vector map to the current layer tree.

Definition at line 1525 of file lmgr/frame.py.

Referenced by frame.GMFrame.OnAddVectorMisc().

def frame.GMFrame.OnAddVectorTheme (   self,
  event 
)

Add thematic vector map to the current layer tree.

Definition at line 1520 of file lmgr/frame.py.

Referenced by frame.GMFrame.OnAddVectorMisc().

def frame.GMFrame.OnCBPageChanged (   self,
  event 
)

Page in notebook (display) changed.

Definition at line 420 of file lmgr/frame.py.

References frame.GMFrame.curr_page, and frame.GMFrame.curr_pagenum.

def frame.GMFrame.OnCBPageClosed (   self,
  event 
)

Page of notebook closed Also close associated map display.

Definition at line 443 of file lmgr/frame.py.

References frame.GMFrame.curr_page, frame.GMFrame.curr_pagenum, frame.GMFrame.OnWorkspaceSaveAs(), frame.GMFrame.SaveToWorkspaceFile(), and frame.GMFrame.workspaceFile.

def frame.GMFrame.OnChangeLocation (   self,
  event 
)
Change current location

Definition at line 637 of file lmgr/frame.py.

References frame.GMFrame.OnWorkspaceClose(), frame.GMFrame.OnWorkspaceNew(), and gcmd.RunCommand().

def frame.GMFrame.OnChangeMapset (   self,
  event 
)
Change current mapset

Definition at line 683 of file lmgr/frame.py.

References gcmd.RunCommand().

def frame.GMFrame.OnCreateMapset (   self,
  event 
)

Create new mapset.

Definition at line 662 of file lmgr/frame.py.

References gcmd.RunCommand().

def frame.GMFrame.OnDeleteLayer (   self,
  event 
)

Remove selected map layer from the current layer Tree.

Definition at line 1627 of file lmgr/frame.py.

References frame.GMFrame.curr_page, and frame.GMFrame.MsgNoLayerSelected().

def frame.GMFrame.OnDisplayClose (   self,
  event = None 
)

Close current map display window.

Definition at line 1075 of file lmgr/frame.py.

References frame.GMFrame.curr_page.

def frame.GMFrame.OnDisplayCloseAll (   self,
  event = None 
)

Close all open map display windows.

Definition at line 1081 of file lmgr/frame.py.

References tools.range.

Referenced by frame.GMFrame.OnCloseWindow(), and frame.GMFrame.OnWorkspaceClose().

def frame.GMFrame.OnEditImageryGroups (   self,
  event,
  cmd = None 
)

Show dialog for creating and editing groups.

Definition at line 1177 of file lmgr/frame.py.

def frame.GMFrame.OnGCPManager (   self,
  event 
)

Launch georectifier module.

Definition at line 362 of file lmgr/frame.py.

def frame.GMFrame.OnGModeler (   self,
  event 
)

Launch Graphical Modeler.

Definition at line 367 of file lmgr/frame.py.

def frame.GMFrame.OnHelp (   self,
  event 
)

Show help.

Definition at line 1208 of file lmgr/frame.py.

def frame.GMFrame.OnHistogram (   self,
  event 
)

Init histogram display canvas and tools.

Definition at line 1213 of file lmgr/frame.py.

def frame.GMFrame.OnImportDxfFile (   self,
  event,
  cmd = None 
)

Convert multiple DXF layers to GRASS vector map layers.

Definition at line 1256 of file lmgr/frame.py.

def frame.GMFrame.OnImportGdalLayers (   self,
  event,
  cmd = None 
)

Convert multiple GDAL layers to GRASS raster map layers.

Definition at line 1262 of file lmgr/frame.py.

Referenced by frame.GMFrame.OnImportMenu().

def frame.GMFrame.OnImportMenu (   self,
  event 
)

Import maps menu (import, link)

Definition at line 745 of file lmgr/frame.py.

References frame.GMFrame._popupMenu(), frame.GMFrame.OnImportGdalLayers(), and frame.GMFrame.OnImportOgrLayers().

def frame.GMFrame.OnImportOgrLayers (   self,
  event,
  cmd = None 
)

Convert multiple OGR layers to GRASS vector map layers.

Definition at line 1274 of file lmgr/frame.py.

Referenced by frame.GMFrame.OnImportMenu().

def frame.GMFrame.OnImportWMS (   self,
  event 
)

Import data from OGC WMS server.

Definition at line 1286 of file lmgr/frame.py.

def frame.GMFrame.OnInstallExtension (   self,
  event 
)

Install extension from GRASS Addons SVN repository.

Definition at line 1184 of file lmgr/frame.py.

def frame.GMFrame.OnKeyDown (   self,
  event 
)

Key pressed.

Definition at line 1667 of file lmgr/frame.py.

References frame.GMFrame.OnAddRaster(), and frame.GMFrame.OnAddVector().

def frame.GMFrame.OnLinkGdalLayers (   self,
  event,
  cmd = None 
)

Link multiple GDAL layers to GRASS raster map layers.

Definition at line 1268 of file lmgr/frame.py.

def frame.GMFrame.OnLinkOgrLayers (   self,
  event,
  cmd = None 
)

Links multiple OGR layers to GRASS vector map layers.

Definition at line 1280 of file lmgr/frame.py.

def frame.GMFrame.OnLocationWizard (   self,
  event 
)

Launch location wizard.

Definition at line 325 of file lmgr/frame.py.

References gcmd.RunCommand().

def frame.GMFrame.OnMapCalculator (   self,
  event,
  cmd = '' 
)

Init map calculator for interactive creation of mapcalc statements.

Definition at line 1234 of file lmgr/frame.py.

References frame.GMFrame.GetMenuCmd().

def frame.GMFrame.OnMapsets (   self,
  event 
)

Launch mapset access dialog.

Definition at line 408 of file lmgr/frame.py.

References gcmd.RunCommand().

def frame.GMFrame.OnMenuCmd (   self,
  event = None,
  cmd = [] 
)

Parse command selected from menu.

Definition at line 532 of file lmgr/frame.py.

References frame.GMFrame.GetMenuCmd().

def frame.GMFrame.OnNewDisplay (   self,
  event = None 
)

Create new layer tree and map display instance.

Definition at line 1369 of file lmgr/frame.py.

References frame.GMFrame.NewDisplay().

def frame.GMFrame.OnNewDisplayWMS (   self,
  event = None 
)

Create new layer tree and map display instance.

Definition at line 1365 of file lmgr/frame.py.

def frame.GMFrame.OnNewVector (   self,
  event 
)
def frame.GMFrame.OnPageChanged (   self,
  event 
)

Page in notebook changed.

Definition at line 432 of file lmgr/frame.py.

def frame.GMFrame.OnPreferences (   self,
  event 
)

General GUI preferences/settings.

Definition at line 1196 of file lmgr/frame.py.

References frame.GMFrame.dialogs, mapdisplay.MapFrame.dialogs, and frame.GMFrame.OnSettingsChanged().

def frame.GMFrame.OnProfile (   self,
  event 
)

Launch profile tool.

Definition at line 1224 of file lmgr/frame.py.

def frame.GMFrame.OnPsMap (   self,
  event 
)

Launch Cartographic Composer.

Definition at line 374 of file lmgr/frame.py.

def frame.GMFrame.OnRenameDisplay (   self,
  event 
)

Change Map Display name.

Definition at line 1091 of file lmgr/frame.py.

References frame.GMFrame.curr_pagenum.

def frame.GMFrame.OnRunModel (   self,
  event 
)

Run model.

Definition at line 389 of file lmgr/frame.py.

def frame.GMFrame.OnRunScript (   self,
  event 
)

Run script.

Definition at line 577 of file lmgr/frame.py.

References gcmd.RunCommand().

def frame.GMFrame.OnSettingsChanged (   self,
  event 
)

Here can be functions which have to be called after EVT_SETTINGS_CHANGED.

Now only set copying of selected text to clipboard (in goutput).

Definition at line 355 of file lmgr/frame.py.

References frame.GMFrame._setCopyingOfSelectedText().

Referenced by frame.GMFrame.OnPreferences().

def frame.GMFrame.OnUninstallExtension (   self,
  event 
)

Uninstall extension.

Definition at line 1190 of file lmgr/frame.py.

def frame.GMFrame.OnVDigit (   self,
  event 
)

Start vector digitizer.

Definition at line 538 of file lmgr/frame.py.

References frame.GMFrame.curr_page, frame.GMFrame.GetLayerTree(), and frame.GMFrame.MsgNoLayerSelected().

def frame.GMFrame.OnVectorCleaning (   self,
  event,
  cmd = '' 
)

Init interactive vector cleaning.

Definition at line 1248 of file lmgr/frame.py.

def frame.GMFrame.OnWorkspaceClose (   self,
  event = None 
)

Close file with workspace definition.

If workspace has been modified ask user to save the changes.

Definition at line 1061 of file lmgr/frame.py.

References frame.ModelFrame.baseTitle, frame.GMFrame.baseTitle, frame.GMFrame.curr_page, frame.GMFrame.disp_idx, frame.GMFrame.OnDisplayCloseAll(), frame.GMFrame.workspaceChanged, and frame.GMFrame.workspaceFile.

Referenced by frame.GMFrame.OnChangeLocation(), and frame.GMFrame.OnWorkspaceOpen().

def frame.GMFrame.OnWorkspaceLoadGrcFile (   self,
  event 
)

Load map layers from GRC file (Tcl/Tk GUI) into map layer tree.

Definition at line 948 of file lmgr/frame.py.

References frame.GMFrame.curr_page, and frame.GMFrame.NewDisplay().

def frame.GMFrame.OnWorkspaceOpen (   self,
  event = None 
)
def frame.GMFrame.OnXTerm (   self,
  event,
  need_xmon = True 
)

Run commands that need interactive xmon.

Parameters:
need_xmonTrue to start X monitor

Definition at line 1124 of file lmgr/frame.py.

References frame.GMFrame.GetMenuCmd(), and gcmd.RunCommand().

Referenced by frame.GMFrame.OnXTermNoXMon().

def frame.GMFrame.OnXTermNoXMon (   self,
  event 
)

Run commands that need xterm.

Definition at line 1118 of file lmgr/frame.py.

References frame.GMFrame.OnXTerm().

Remove nviz notebook page.

Definition at line 305 of file lmgr/frame.py.

References frame.GMFrame.nviz.

def frame.GMFrame.RulesCmd (   self,
  event 
)

Launches dialog for commands that need rules input and processes rules.

Definition at line 1105 of file lmgr/frame.py.

References frame.GMFrame.GetMenuCmd().

def frame.GMFrame.RunMenuCmd (   self,
  event = None,
  cmd = [] 
)

Run command selected from menu.

Definition at line 526 of file lmgr/frame.py.

References frame.GMFrame.GetMenuCmd().

def frame.GMFrame.SaveToWorkspaceFile (   self,
  filename 
)

Save layer tree layout to workspace file.

Return True on success, False on error

Definition at line 1033 of file lmgr/frame.py.

Referenced by frame.GMFrame.OnCBPageClosed(), frame.GMFrame.OnCloseWindow(), frame.GMFrame.OnWorkspaceSave(), and frame.GMFrame.OnWorkspaceSaveAs().


Field Documentation

Definition at line 98 of file lmgr/frame.py.

Definition at line 97 of file lmgr/frame.py.

Definition at line 248 of file lmgr/frame.py.

Definition at line 79 of file lmgr/frame.py.

Referenced by frame.GMFrame.OnAboutGRASS().

Definition at line 216 of file lmgr/frame.py.

Definition at line 218 of file lmgr/frame.py.

Referenced by frame.GMFrame.GetMenuCmd().

Definition at line 402 of file lmgr/frame.py.

Referenced by frame.GMFrame.OnDone().

Definition at line 108 of file lmgr/frame.py.

Referenced by frame.GMFrame.IsPaneShown().

Definition at line 298 of file lmgr/frame.py.

Referenced by frame.GMFrame.RemoveNvizTools().

Definition at line 1385 of file lmgr/frame.py.

Definition at line 270 of file lmgr/frame.py.

Definition at line 263 of file lmgr/frame.py.

Definition at line 107 of file lmgr/frame.py.


The documentation for this class was generated from the following file: