File: properties.py

package info (click to toggle)
grass 8.4.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 277,040 kB
  • sloc: ansic: 460,798; python: 227,732; cpp: 42,026; sh: 11,262; makefile: 7,007; xml: 3,637; sql: 968; lex: 520; javascript: 484; yacc: 450; asm: 387; perl: 157; sed: 25; objc: 6; ruby: 4
file content (458 lines) | stat: -rw-r--r-- 13,980 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
"""
@package mapdisp.properties

@brief Classes for map display properties management

Classes:
 - properties::PropertyItem
 - properties::ChBRender
 - properties::ChBShowRegion
 - properties::ChBAlignExtent
 - properties::ChBResolution
 - properties::ChBProjection
 - properties::RBShowInStatusbar
 - properties::MapDisplayPropertiesDialog

(C) 2021 by the GRASS Development Team

This program is free software under the GNU General Public License
(>=v2). Read the file COPYING that comes with GRASS for details.

@author Vaclav Petras <wenzeslaus gmail.com>
@author Anna Kratochvilova <kratochanna gmail.com>
@author Linda Kladivova <lindakladivova gmail.com>
"""

import wx
import wx.lib.scrolledpanel as SP
from gui_core.wrap import Button


class PropertyItem:
    """Base class for Map Display properties widgets that use property signals"""

    def __init__(self, mapWindowProperties):
        self._properties = mapWindowProperties

    @property
    def mapWindowProperty(self):
        pass

    @mapWindowProperty.setter
    def mapWindowProperty(self, value):
        pass

    def mapWindowPropertyChanged(self):
        """Returns signal from MapWindowProperties."""
        pass

    def _setValue(self, value):
        self.widget.SetValue(value)

    def GetValue(self):
        return self.widget.GetValue()

    def GetWidget(self):
        """Returns underlying widget.

        :return: widget or None if doesn't exist
        """
        return self.widget

    def _connect(self):
        self.mapWindowPropertyChanged().connect(self._setValue)

    def _disconnect(self):
        self.mapWindowPropertyChanged().disconnect(self._setValue)

    def _onToggle(self, event):
        self._disconnect()
        self.mapWindowProperty = self.GetValue()
        self._connect()


class ChBRender(PropertyItem):
    """Checkbox to enable and disable auto-rendering."""

    def __init__(self, parent, mapWindowProperties):
        PropertyItem.__init__(self, mapWindowProperties)
        self.name = "render"
        self.widget = wx.CheckBox(
            parent=parent, id=wx.ID_ANY, label=_("Enable auto-rendering")
        )
        self.widget.SetValue(self.mapWindowProperty)
        self.widget.SetToolTip(wx.ToolTip(_("Enable/disable auto-rendering")))

        self.widget.Bind(wx.EVT_CHECKBOX, self._onToggle)
        self._connect()

    @property
    def mapWindowProperty(self):
        return self._properties.autoRender

    @mapWindowProperty.setter
    def mapWindowProperty(self, value):
        self._properties.autoRender = value

    def mapWindowPropertyChanged(self):
        return self._properties.autoRenderChanged


class ChBAlignExtent(PropertyItem):
    """Checkbox to select zoom behavior.

    Used by BufferedWindow (through MapFrame property).
    See tooltip for explanation.
    """

    def __init__(self, parent, mapWindowProperties):
        PropertyItem.__init__(self, mapWindowProperties)
        self.name = "alignExtent"
        self.widget = wx.CheckBox(
            parent=parent,
            id=wx.ID_ANY,
            label=_("Align region extent based on display size"),
        )
        self.widget.SetValue(self.mapWindowProperty)
        self.widget.SetToolTip(
            wx.ToolTip(
                _(
                    "Align region extent based on display "
                    "size from center point. "
                    "Default value for new map displays can "
                    "be set up in 'User GUI settings' dialog."
                )
            )
        )
        self.widget.Bind(wx.EVT_CHECKBOX, self._onToggle)
        self._connect()

    @property
    def mapWindowProperty(self):
        return self._properties.alignExtent

    @mapWindowProperty.setter
    def mapWindowProperty(self, value):
        self._properties.alignExtent = value

    def mapWindowPropertyChanged(self):
        return self._properties.alignExtentChanged


class ChBResolution(PropertyItem):
    """Checkbox to select used display resolution."""

    def __init__(self, parent, mapframe, mapWindowProperties):
        PropertyItem.__init__(self, mapWindowProperties)
        self.mapFrame = mapframe
        self.name = "resolution"
        self.widget = wx.CheckBox(
            parent=parent,
            id=wx.ID_ANY,
            label=_("Constrain display resolution to computational settings"),
        )
        self.widget.SetValue(self.mapWindowProperty)
        self.widget.SetToolTip(
            wx.ToolTip(
                _(
                    "Constrain display resolution "
                    "to computational region settings. "
                    "Default value for new map displays can "
                    "be set up in 'User GUI settings' dialog."
                )
            )
        )
        self.widget.Bind(wx.EVT_CHECKBOX, self._onToggle)
        self._connect()

    @property
    def mapWindowProperty(self):
        return self._properties.resolution

    @mapWindowProperty.setter
    def mapWindowProperty(self, value):
        self._properties.resolution = value

    def mapWindowPropertyChanged(self):
        return self._properties.resolutionChanged

    def _onToggle(self, event):
        """Update display when toggle display mode"""
        super()._onToggle(event)

        # redraw map if auto-rendering is enabled
        if self._properties.autoRender:
            self.mapFrame.GetWindow().UpdateMap()


class ChBShowRegion(PropertyItem):
    """Checkbox to enable and disable showing of computational region."""

    def __init__(self, parent, mapframe, mapWindowProperties):
        PropertyItem.__init__(self, mapWindowProperties)
        self.mapFrame = mapframe
        self.name = "showRegion"
        self.widget = wx.CheckBox(
            parent=parent, id=wx.ID_ANY, label=_("Show computational extent")
        )
        self.widget.SetValue(self.mapWindowProperty)
        self.widget.SetToolTip(
            wx.ToolTip(
                _(
                    "Show/hide computational "
                    "region extent (set with g.region). "
                    "Display region drawn as a blue box inside the "
                    "computational region, "
                    "computational region inside a display region "
                    "as a red box)."
                )
            )
        )
        self.widget.Bind(wx.EVT_CHECKBOX, self._onToggle)
        self._connect()

    @property
    def mapWindowProperty(self):
        return self._properties.showRegion

    @mapWindowProperty.setter
    def mapWindowProperty(self, value):
        self._properties.showRegion = value

    def mapWindowPropertyChanged(self):
        return self._properties.showRegionChanged

    def _onToggle(self, event):
        """Shows/Hides extent (comp. region) in map canvas.

        Shows or hides according to checkbox value.
        """
        super()._onToggle(event)

        # redraw map if auto-rendering is enabled
        if self._properties.autoRender:
            self.mapFrame.GetWindow().UpdateMap(render=False)


class ChBProjection(PropertyItem):
    """Checkbox to enable user defined projection"""

    def __init__(self, parent, mapWindowProperties):
        PropertyItem.__init__(self, mapWindowProperties)
        self.name = "useDefinedProjection"
        self.defaultLabel = _("Display coordinates in different CRS")
        self.widget = wx.CheckBox(parent=parent, id=wx.ID_ANY, label=self.defaultLabel)
        self.widget.SetValue(self.mapWindowProperty)
        self.widget.SetToolTip(
            wx.ToolTip(
                _(
                    "Reproject coordinates displayed "
                    "in the statusbar. Coordinate reference system can be "
                    "specified in GUI preferences dialog "
                    "(tab 'Projection')"
                )
            )
        )
        self.widget.Bind(wx.EVT_CHECKBOX, self._onToggle)
        self._connect()

    @property
    def mapWindowProperty(self):
        return self._properties.useDefinedProjection

    @mapWindowProperty.setter
    def mapWindowProperty(self, value):
        self._properties.useDefinedProjection = value

    def mapWindowPropertyChanged(self):
        return self._properties.useDefinedProjectionChanged

    def _onToggle(self, event):
        super()._onToggle(event)
        epsg = self._properties.epsg
        if epsg:
            label = _("{label} (EPSG: {epsg})").format(
                label=self.defaultLabel, epsg=epsg
            )
            self.widget.SetLabel(label)
        else:
            self.widget.SetLabel(self.defaultLabel)


class RBShowInStatusbar(PropertyItem):
    """Radiobox managing widgets in statusbar."""

    def __init__(self, parent, mapWindowProperties, sbmanager):
        PropertyItem.__init__(self, mapWindowProperties)
        self.name = "showInStatusbar"
        self.statusbarManager = sbmanager

        choices = self.statusbarManager.GetItemLabels()
        self.widget = wx.RadioBox(
            parent=parent,
            id=wx.ID_ANY,
            label="Displayed content",
            choices=choices,
            majorDimension=1,
            style=wx.RA_SPECIFY_COLS,
        )
        self._setValue(self.mapWindowProperty)
        self._disableItems()

        self.widget.Bind(wx.EVT_RADIOBOX, self._onToggle)
        self._connect()

    def _setValue(self, mode):
        self.widget.SetSelection(mode)

    def GetValue(self):
        return self.widget.GetSelection()

    def _disableItems(self):
        """Disables a radiobox options"""
        for item in self.statusbarManager.disabledItems.keys():
            self.widget.EnableItem(n=item, enable=False)

    @property
    def mapWindowProperty(self):
        return self._properties.sbItem

    @mapWindowProperty.setter
    def mapWindowProperty(self, value):
        self._properties.sbItem = value

    def mapWindowPropertyChanged(self):
        return self._properties.sbItemChanged


class MapDisplayPropertiesDialog(wx.Dialog):
    """Map Display properties dialog"""

    def __init__(
        self,
        parent,
        mapframe,
        properties,
        sbmanager,
        title=_("Map Display Settings"),
        size=(-1, 300),
        style=wx.DEFAULT_DIALOG_STYLE | wx.RESIZE_BORDER,
    ):
        wx.Dialog.__init__(self, parent=parent, id=wx.ID_ANY, title=title, style=style)

        self.parent = parent
        self.title = title
        self.size = size
        self.mapframe = mapframe
        self.mapWindowProperties = properties
        self.statusbarManager = sbmanager

        # notebook
        self.notebook = wx.Notebook(parent=self, id=wx.ID_ANY, style=wx.BK_DEFAULT)
        # create notebook pages
        self._createDisplayPage(parent=self.notebook)
        self._createStatusBarPage(parent=self.notebook)

        self.btnClose = Button(self, wx.ID_CLOSE)
        self.SetEscapeId(wx.ID_CLOSE)

        self._layout()

    def _layout(self):
        """Layout window"""
        # sizers
        btnStdSizer = wx.StdDialogButtonSizer()
        btnStdSizer.AddButton(self.btnClose)
        btnStdSizer.Realize()

        mainSizer = wx.BoxSizer(wx.VERTICAL)
        mainSizer.Add(self.notebook, proportion=1, flag=wx.EXPAND | wx.ALL, border=5)
        mainSizer.Add(btnStdSizer, proportion=0, flag=wx.EXPAND | wx.ALL, border=5)

        self.SetSizer(mainSizer)
        self.SetMinSize(self.GetBestSize())
        self.SetSize(self.size)

    def _createDisplayPage(self, parent):
        """Create notebook page for display settings"""

        panel = SP.ScrolledPanel(parent=parent, id=wx.ID_ANY)
        panel.SetupScrolling(scroll_x=False, scroll_y=True)
        parent.AddPage(page=panel, text=_("General"))

        # General settings
        sizer = wx.BoxSizer(wx.VERTICAL)

        # Auto-rendering
        self.autoRendering = ChBRender(panel, self.mapWindowProperties)
        sizer.Add(
            self.autoRendering.GetWidget(),
            proportion=0,
            flag=wx.EXPAND | wx.ALL,
            border=3,
        )

        # Align extent to display size
        self.alignExtent = ChBAlignExtent(panel, self.mapWindowProperties)
        sizer.Add(
            self.alignExtent.GetWidget(),
            proportion=0,
            flag=wx.EXPAND | wx.ALL,
            border=3,
        )

        # Use computation resolution
        self.compResolution = ChBResolution(
            panel, self.mapframe, self.mapWindowProperties
        )
        sizer.Add(
            self.compResolution.GetWidget(),
            proportion=0,
            flag=wx.EXPAND | wx.ALL,
            border=3,
        )

        # Show computation extent
        self.showCompExtent = ChBShowRegion(
            panel, self.mapframe, self.mapWindowProperties
        )
        sizer.Add(
            self.showCompExtent.GetWidget(),
            proportion=0,
            flag=wx.EXPAND | wx.ALL,
            border=3,
        )

        panel.SetSizer(sizer)

    def _createStatusBarPage(self, parent):
        """Create notebook page for statusbar settings"""

        panel = SP.ScrolledPanel(parent=parent, id=wx.ID_ANY)
        panel.SetupScrolling(scroll_x=False, scroll_y=True)
        parent.AddPage(page=panel, text=_("Status bar"))

        sizer = wx.BoxSizer(wx.VERTICAL)

        self.shownInStatusbar = RBShowInStatusbar(
            parent=panel,
            mapWindowProperties=self.mapWindowProperties,
            sbmanager=self.statusbarManager,
        )
        sizer.Add(
            self.shownInStatusbar.GetWidget(),
            proportion=0,
            flag=wx.EXPAND | wx.ALL,
            border=3,
        )

        # Display coordinates in different CRS
        self.projection = ChBProjection(panel, self.mapWindowProperties)
        sizer.Add(
            self.projection.GetWidget(),
            proportion=0,
            flag=wx.EXPAND | wx.ALL,
            border=3,
        )

        panel.SetSizer(sizer)