commotion_client.GUI.toolbar_builder.ToolBar Class Reference
Inheritance diagram for commotion_client.GUI.toolbar_builder.ToolBar:

Public Member Functions

def __init__
 
def init_settings
 
def load_settings
 
def load_about
 
def load_update
 
def load_user
 
def exit_application
 
def load_extensions
 
def init_user
 
def init_extension_toolbar
 

Public Attributes

 log
 
 translate
 
 viewport
 
 toolbar
 
 settings
 

Detailed Description

The Core toolbar object that populates manditory toolbar sections.

Constructor & Destructor Documentation

def commotion_client.GUI.toolbar_builder.ToolBar.__init__ (   self,
  viewport,
  parent = None,
  extension_toolbar = None 
)
Creates the core toolbar including any extension toolbar passed to it.

Initializes the core functionality of the toolbar. If an extension_toolbar object is also passed to the toolbar it will attempt to add the extension toolbar into itself.

Args:
  extension_toolbar (object): The extension specific menu-item to be used by an extension. This class is derived from the "commotion_client/GUI/extension_toolbar.ExtensionToolBar" object.
  viewport (object): The current viewport. This allows menu_items to have its actions interact with the current viewport.

Raises:
  exception: Description.

References commotion_client.GUI.main_window.MainWindow._dirty, commotion_client.GUI.toolbar_builder.ToolBar._dirty, commotion_client.GUI.extension_toolbar.ExtensionToolBar._dirty, commotion_client.GUI.toolbar.ToolBar._dirty, commotion_client.extensions.config_editor.main.ViewPort._dirty, commotion_client.GUI.extension_toolbar.MenuItem._dirty, commotion_client.GUI.toolbar.ToolBar.init_settings(), commotion_client.GUI.toolbar_builder.ToolBar.init_settings(), commotion_client.GUI.system_tray.TrayIcon.log, commotion_client.GUI.menu_bar.MenuBar.log, commotion_client.GUI.crash_report.CrashReport.log, commotion_client.extensions.config_editor.main.ViewPort.log, commotion_client.GUI.main_window.MainWindow.log, commotion_client.GUI.toolbar_builder.ToolBar.log, commotion_client.GUI.toolbar.ToolBar.log, commotion_client.GUI.extension_toolbar.ExtensionToolBar.log, commotion_client.commotion_client.HoldStateDuringRestart.log, commotion_client.GUI.extension_toolbar.MenuItem.log, commotion_client.GUI.crash_report.ReportGatherer.log, commotion_client.commotion_client.CommotionClientApplication.log, commotion_client.GUI.toolbar.ToolBar.settings, commotion_client.GUI.toolbar_builder.ToolBar.settings, commotion_client.GUI.toolbar_builder.ToolBar.toolbar, commotion_client.GUI.toolbar.ToolBar.toolbar, commotion_client.GUI.main_window.MainWindow.toolbar, commotion_client.GUI.menu_bar.MenuBar.translate, commotion_client.extensions.config_editor.main.ViewPort.translate, commotion_client.GUI.main_window.MainWindow.translate, commotion_client.GUI.toolbar_builder.ToolBar.translate, commotion_client.GUI.extension_toolbar.ExtensionToolBar.translate, commotion_client.GUI.toolbar.ToolBar.translate, commotion_client.GUI.extension_toolbar.MenuItem.translate, commotion_client.commotion_client.CommotionClientApplication.translate, commotion_client.GUI.extension_toolbar.ExtensionToolBar.viewport, commotion_client.GUI.toolbar_builder.ToolBar.viewport, commotion_client.GUI.toolbar.ToolBar.viewport, commotion_client.GUI.main_window.MainWindow.viewport, and commotion_client.GUI.extension_toolbar.MenuItem.viewport.

29 
30  def __init__(self, viewport, parent=None, extension_toolbar=None):
31  """Creates the core toolbar including any extension toolbar passed to it.
32 
33  Initializes the core functionality of the toolbar. If an extension_toolbar object is also passed to the toolbar it will attempt to add the extension toolbar into itself.
34 
35  Args:
36  extension_toolbar (object): The extension specific menu-item to be used by an extension. This class is derived from the "commotion_client/GUI/extension_toolbar.ExtensionToolBar" object.
37  viewport (object): The current viewport. This allows menu_items to have its actions interact with the current viewport.
38 
39  Raises:
40  exception: Description.
41 
42  """
43  super().__init__()
44  self._dirty = False
45  self.log = logging.getLogger("commotion_client."+__name__)
46  self.translate = QtCore.QCoreApplication.translate
47 
48  self.viewport = viewport
49  #Create toolbar object
50  self.toolbar = QtGui.QToolBar(self)
51  self.toolbar.setToolButtonStyle(QtCore.Qt.ToolButtonTextUnderIcon)
52  #Create & add settings item
53  self.init_settings()
54  self.toolbar.addWidget(self.settings)
55  #Create & add user item
56 # self.user = self.init_user()
57 # self.toolbar.addWidget(self.user)
58  #Create extension toolbar section if needed
59 # if extension_toolbar:
60 # self.extension_toolbar = extension_toolbar(self, viewport)
61 # self.init_extension_toolbar()
translate
Definition: toolbar_builder.py:45
settings
Definition: toolbar_builder.py:77
toolbar
Definition: toolbar_builder.py:49
_dirty
Definition: toolbar_builder.py:43
viewport
Definition: toolbar_builder.py:47
log
Definition: toolbar_builder.py:44
def init_settings
Definition: toolbar_builder.py:62
def __init__
Definition: toolbar_builder.py:29

Member Function Documentation

def commotion_client.GUI.toolbar_builder.ToolBar.exit_application (   self)
Exits the application.

Referenced by commotion_client.GUI.toolbar_builder.ToolBar.init_settings().

130  def exit_application(self):
131  """Exits the application."""
132  pass
def exit_application
Definition: toolbar_builder.py:129
def commotion_client.GUI.toolbar_builder.ToolBar.init_extension_toolbar (   self)
short description

long description

Args:
name (type): Description.

Returns:
Description.

Raises:
exception: Description.
157  def init_extension_toolbar(self):
158  """short description
159 
160  long description
161 
162  Args:
163  name (type): Description.
164 
165  Returns:
166  Description.
167 
168  Raises:
169  exception: Description.
170  """
171  for menu_item in self.extension_menu.menu_items:
172  self.toolbar.addWidget(menu_item)
def init_extension_toolbar
Definition: toolbar_builder.py:156
def commotion_client.GUI.toolbar_builder.ToolBar.init_settings (   self)
short description

long description

Args:
name (type): Description.

Returns:
Description.

Raises:
exception: Description.

References commotion_client.GUI.toolbar.ToolBar.exit_application(), commotion_client.GUI.toolbar_builder.ToolBar.exit_application(), commotion_client.GUI.toolbar.ToolBar.load_about(), commotion_client.GUI.toolbar_builder.ToolBar.load_about(), commotion_client.GUI.toolbar.ToolBar.load_extensions(), commotion_client.GUI.toolbar_builder.ToolBar.load_extensions(), commotion_client.GUI.toolbar.ToolBar.load_settings(), commotion_client.GUI.toolbar_builder.ToolBar.load_settings(), commotion_client.GUI.main_window.MainWindow.load_settings(), commotion_client.GUI.toolbar.ToolBar.load_update(), commotion_client.GUI.toolbar_builder.ToolBar.load_update(), commotion_client.GUI.toolbar.ToolBar.settings, commotion_client.GUI.toolbar_builder.ToolBar.settings, commotion_client.GUI.toolbar_builder.ToolBar.toolbar, commotion_client.GUI.toolbar.ToolBar.toolbar, commotion_client.GUI.main_window.MainWindow.toolbar, commotion_client.GUI.menu_bar.MenuBar.translate, commotion_client.extensions.config_editor.main.ViewPort.translate, commotion_client.GUI.main_window.MainWindow.translate, commotion_client.GUI.toolbar_builder.ToolBar.translate, commotion_client.GUI.toolbar.ToolBar.translate, commotion_client.GUI.extension_toolbar.ExtensionToolBar.translate, commotion_client.GUI.extension_toolbar.MenuItem.translate, and commotion_client.commotion_client.CommotionClientApplication.translate.

Referenced by commotion_client.GUI.toolbar_builder.ToolBar.__init__().

62 
63  def init_settings(self):
64  """short description
65 
66  long description
67 
68  Args:
69  name (type): Description.
70 
71  Returns:
72  Description.
73 
74  Raises:
75  exception: Description.
76 
77  """
78  self.settings = QtGui.QToolButton(self.toolbar)
79  # settings = extension_toolbar.MenuItem(self.toolbar, self.viewport)
80 # self.settings.setText(self.translate("menu", "Settings"))
81  # settings.set_menu(True)
82 # self.settings.setIcon(QtGui.QIcon(":logo48.png"))
83  self.settings.setPopupMode(QtGui.QToolButton.InstantPopup)
84  self.settings.setMenu(QtGui.QMenu(self.settings))
85 
86 
87  extensions_item = QtGui.QAction(self.translate("menu", "&Extensions"), self.settings)
88  extensions_item.setStatusTip(self.translate("menu", "Open the extensions menu."))
89  extensions_item.triggered.connect(self.load_extensions)
90  self.settings.menu().addAction(extensions_item)
91 
92  settings_item = QtGui.QAction(QtGui.QIcon(":settings32.png"), self.translate("menu", "&Settings"), self.settings)
93  settings_item.setStatusTip(self.translate("menu", "Open the settings menu."))
94  settings_item.triggered.connect(self.load_settings)
95  self.settings.menu().addAction(settings_item)
96  self.settings.setDefaultAction(settings_item)
97 
98  about_item = QtGui.QAction(self.translate("menu", "&About"), self.settings)
99  about_item.setStatusTip(self.translate("menu", "Open the \'about us\' page"))
100  about_item.triggered.connect(self.load_about)
101  self.settings.menu().addAction(about_item)
102 
103  exit_item = QtGui.QAction(self.translate("menu", "&Exit"), self.settings)
104  exit_item.setStatusTip(self.translate("menu", "Exit the application."))
105  exit_item.triggered.connect(self.exit_application)
106  self.settings.menu().addAction(exit_item)
107 
108  update_item = QtGui.QAction(self.translate("menu", "&Update"), self.settings)
109  update_item.setStatusTip(self.translate("menu", "Open the updates page."))
110  update_item.triggered.connect(self.load_update)
111  self.settings.menu().addAction(update_item)
112 
def exit_application
Definition: toolbar_builder.py:129
def load_about
Definition: toolbar_builder.py:117
translate
Definition: toolbar_builder.py:45
def load_update
Definition: toolbar_builder.py:121
settings
Definition: toolbar_builder.py:77
toolbar
Definition: toolbar_builder.py:49
def load_settings
Definition: toolbar_builder.py:113
def load_extensions
Definition: toolbar_builder.py:133
def init_settings
Definition: toolbar_builder.py:62
def commotion_client.GUI.toolbar_builder.ToolBar.init_user (   self)
short description

long description

Args:
name (type): Description.

Returns:
Description.

Raises:
exception: Description.
138  def init_user(self):
139  """short description
140 
141  long description
142 
143  Args:
144  name (type): Description.
145 
146  Returns:
147  Description.
148 
149  Raises:
150  exception: Description.
151 
152  """
153  pass
154 
155 
def init_user
Definition: toolbar_builder.py:137
def commotion_client.GUI.toolbar_builder.ToolBar.load_about (   self)
Opens the about page in the main viewport 

Referenced by commotion_client.GUI.toolbar_builder.ToolBar.init_settings().

118  def load_about(self):
119  """Opens the about page in the main viewport """
120  pass
def load_about
Definition: toolbar_builder.py:117
def commotion_client.GUI.toolbar_builder.ToolBar.load_extensions (   self)
Opens the extensions menu in the main viewport 

Referenced by commotion_client.GUI.toolbar_builder.ToolBar.init_settings().

134  def load_extensions(self):
135  """Opens the extensions menu in the main viewport """
136  pass
def load_extensions
Definition: toolbar_builder.py:133
def commotion_client.GUI.toolbar_builder.ToolBar.load_settings (   self)
Opens the settings menu in the main viewport 

Referenced by commotion_client.GUI.toolbar_builder.ToolBar.init_settings().

114  def load_settings(self):
115  """Opens the settings menu in the main viewport """
116  pass
def load_settings
Definition: toolbar_builder.py:113
def commotion_client.GUI.toolbar_builder.ToolBar.load_update (   self)
Opens the updates menu in the main viewport 

Referenced by commotion_client.GUI.toolbar_builder.ToolBar.init_settings().

122  def load_update(self):
123  """Opens the updates menu in the main viewport """
124  pass
def load_update
Definition: toolbar_builder.py:121
def commotion_client.GUI.toolbar_builder.ToolBar.load_user (   self)
Opens the user menu in the main viewport 
126  def load_user(self):
127  """Opens the user menu in the main viewport """
128  pass
def load_user
Definition: toolbar_builder.py:125

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