[go: up one dir, main page]
Menu ▾ ▴

[dfe9bc]: / ui / app.py  Maximize  Restore  History

Download this file

138 lines (114 with data), 3.5 kB 

  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
# ******************************************************

# * Copyright © 2017-2023 - Jordan Irwin (AntumDeluge) *

# ******************************************************

# * This software is licensed under the MIT license.   *

# * See: LICENSE.txt for details.                      *

# ******************************************************



## Classes & functions for managing app interface.

#

#  @module ui.app



import wx



from libdbr.logger     import Logger

from libdebreate.ident import pnlid





_logger = Logger(__name__)



## Custom wx.App class for setting & retrieving main window instance.

class DebreateApp(wx.App):

  ## App constructor.

  #

  #  @param window

  #    `wx.Window` instance to use as main window.

  def __init__(self, window=None):

    wx.App.__init__(self)

    self.setMainWindow(window)



  ## Retrieves the main window.

  #

  #  @return

  #    `ui.main.MainWindow` instance.

  def getMainWindow(self):

    return self.MainWindow



  ## Alias of `ui.app.DebreateApp.getMainWindow`.

  #

  #  @return

  #    `ui.main.MainWindow` instance.

  #  @deprecated

  #    Use `ui.app.DebreateApp.getMainWindow`.

  def GetMainWindow(self):

    _logger.deprecated(self.GetMainWindow, alt=self.getMainWindow)



    return self.getMainWindow()



  ## Retrieves the wizard.

  #

  #  @return

  #    `ui.wizard.Wizard` instance.

  def getWizard(self):

    if self.MainWindow:

      return self.MainWindow.GetWizard()

    return None



  ## Alias of `ui.app.DebreateApp.getWizard`.

  #

  #  @return

  #    `ui.wizard.Wizard` instance.

  #  @deprecated

  #    Use `ui.app.DebreateApp.getWizard`.

  def GetWizard(self):

    _logger.deprecated(self.GetWizard, alt=self.getWizard)



    return self.getWizard()



  ## Set the main window instance.

  #

  #  @param window

  #    `wx.Frame` instance to use for main window.

  #  @todo

  #    FIXME: move call to `wx.App.SetTopWindow` from `ui.main.MainWindow.__init__`.

  def setMainWindow(self, window):

    self.MainWindow = window

    # FIXME: can just check for attribute 'onInit'

    if window != None and window.GetId() == pnlid.MAIN:

      window.onInit()



  ## Alias of `ui.app.DebreateApp.setMainWindow`.

  #

  #  @param window

  #    `wx.Frame` instance to use for main window.

  #  @deprecated

  #    Use `ui.app.DebreateApp.setMainWindow`.

  def SetMainWindow(self, window):

    _logger.deprecated(self.SetMainWindow, alt=self.setMainWindow)



    self.setMainWindow(window)



  ## Closes main window to end program.

  def shutdown(self):

    if self.MainWindow:

      if self.MainWindow.GetId() == pnlid.MAIN:

        self.MainWindow.saveConfigAndShutdown()

      else:

        self.MainWindow.Destroy()

      self.MainWindow = None





## Helper function to get app instance.

#

#  @return

#    `ui.app.DebreateApp` instance.

def get():

  return wx.GetApp()



## Helper function to get main window instance.

#

#  @return

#    `ui.main.MainWindow` instance.

def getMainWindow():

  return get().getMainWindow()



## Helper function to get menus from main menu.

#

#  @param menuId

#    Menu integer identifier.

#  @return

#    `wx.Menu` instance.

def getMenu(menuId):

  return getMainWindow().getMenu(menuId)



## Helper function to get the wizard interface instance.

#

#  @return

#    `ui.wizard.Wizard` instance.

def getWizard():

  return get().getWizard()



## Helper function go retrieve a page of the wizard.

#

#  @param pageId

#    Integer page identifier.

def getPage(pageId):

  return getWizard().getPage(pageId)