commotion_client.GUI.toolbar.ToolBar Class Reference
Inheritance diagram for commotion_client.GUI.toolbar.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.ToolBar.__init__ (   self,
  parent = None,
  extension_toolbar = None,
  viewport 
)
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.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.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.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.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.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.ToolBar.viewport, commotion_client.GUI.main_window.MainWindow.viewport, and commotion_client.GUI.extension_toolbar.MenuItem.viewport.

30 
31  def __init__(self, parent=None, extension_toolbar=None, viewport):
32  """Creates the core toolbar including any extension toolbar passed to it.
33 
34  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.
35 
36  Args:
37  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.
38  viewport (object): The current viewport. This allows menu_items to have its actions interact with the current viewport.
39 
40  Raises:
41  exception: Description.
42 
43  """
44  super().__init__()
45  self._dirty = False
46  self.log = logging.getLogger("commotion_client."+__name__)
47  self.translate = QtCore.QCoreApplication.translate
48 
49  self.viewport = viewport
50  #Create toolbar object
51  self.toolbar = QtGui.QToolBar(self)
52  #Create & add settings item
53  self.settings = 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()
viewport
Definition: toolbar.py:48
settings
Definition: toolbar.py:52
log
Definition: toolbar.py:45
toolbar
Definition: toolbar.py:50
translate
Definition: toolbar.py:46
def __init__
Definition: toolbar.py:30
def init_settings
Definition: toolbar.py:62
_dirty
Definition: toolbar.py:44

Member Function Documentation

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

Referenced by commotion_client.GUI.toolbar.ToolBar.init_settings(), and commotion_client.GUI.toolbar_builder.ToolBar.init_settings().

125  def exit_application(self):
126  """Exits the application."""
127  pass
def exit_application
Definition: toolbar.py:124
def commotion_client.GUI.toolbar.ToolBar.init_extension_toolbar (   self)
short description

long description

Args:
name (type): Description.

Returns:
Description.

Raises:
exception: Description.
152  def init_extension_toolbar(self):
153  """short description
154 
155  long description
156 
157  Args:
158  name (type): Description.
159 
160  Returns:
161  Description.
162 
163  Raises:
164  exception: Description.
165 
166  """
167  for menu_item in self.extension_menu.menu_items:
168  try:
169  self.toolbar.addWidget(menu_item)
def init_extension_toolbar
Definition: toolbar.py:151
def commotion_client.GUI.toolbar.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.ToolBar.load_about(), commotion_client.GUI.toolbar.ToolBar.load_extensions(), commotion_client.GUI.toolbar.ToolBar.load_settings(), commotion_client.GUI.main_window.MainWindow.load_settings(), commotion_client.GUI.toolbar.ToolBar.load_update(), 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.ToolBar.translate, commotion_client.GUI.extension_toolbar.ExtensionToolBar.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.ToolBar.viewport, commotion_client.GUI.main_window.MainWindow.viewport, and commotion_client.GUI.extension_toolbar.MenuItem.viewport.

Referenced by commotion_client.GUI.toolbar_builder.ToolBar.__init__(), and commotion_client.GUI.toolbar.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  settings_menu = extension_toolbar.MenuItem(self, self.viewport)
79  settings_menu.setIcon(extension_toolbar.icon.settings)
80  settings_menu.setText(self.translate("menu", "Settings"))
81  settings_menu.set_menu = True
82  extensions_item = QtGui.QAction(self.translate("menu", "&Extensions"),
83  statusTip=self.translate("menu", "Open the extensions menu."),
84  triggered=self.load_extensions,
85  parent=settings_menu)
86 
87  settings_item = QtGui.QAction(self.translate("menu", "&Settings"),
88  QtGui.QIcon("icons/load.png"),
89  statusTip=self.translate("menu", "Open the settings menu."),
90  triggered=self.load_settings,
91  parent=settings_menu)
92  about_item = QtGui.QAction(self.translate("menu", "&About"),
93  QtGui.QIcon("icons/load.png"),
94  statusTip=self.translate("menu", "Open the \'about us\' page"),
95  triggered=self.load_about,
96  parent=settings_menu)
97  exit_item = QtGui.QAction(self.translate("menu", "&Exit"),
98  QtGui.QIcon("icons/load.png"),
99  statusTip=self.translate("menu", "Exit the application."),
100  triggered=self.exit_application,
101  parent=settings_menu)
102  update_item = QtGui.QAction(self.translate("menu", "&Update"),
103  QtGui.QIcon("icons/load.png"),
104  statusTip=self.translate("menu", "Open the updates page."),
105  triggered=self.load_update,
106  parent=settings_menu)
107  return settings_menu
Definition: extension_toolbar.py:64
def load_settings
Definition: toolbar.py:108
viewport
Definition: toolbar.py:48
translate
Definition: toolbar.py:46
def load_extensions
Definition: toolbar.py:128
def exit_application
Definition: toolbar.py:124
def init_settings
Definition: toolbar.py:62
def load_update
Definition: toolbar.py:116
def load_about
Definition: toolbar.py:112
def commotion_client.GUI.toolbar.ToolBar.init_user (   self)
short description

long description

Args:
name (type): Description.

Returns:
Description.

Raises:
exception: Description.
133  def init_user(self):
134  """short description
135 
136  long description
137 
138  Args:
139  name (type): Description.
140 
141  Returns:
142  Description.
143 
144  Raises:
145  exception: Description.
146 
147  """
148  pass
149 
150 
def init_user
Definition: toolbar.py:132
def commotion_client.GUI.toolbar.ToolBar.load_about (   self)
Opens the about page in the main viewport 

Referenced by commotion_client.GUI.toolbar.ToolBar.init_settings(), and commotion_client.GUI.toolbar_builder.ToolBar.init_settings().

113  def load_about(self):
114  """Opens the about page in the main viewport """
115  pass
def load_about
Definition: toolbar.py:112
def commotion_client.GUI.toolbar.ToolBar.load_extensions (   self)
Opens the extensions menu in the main viewport 

Referenced by commotion_client.GUI.toolbar.ToolBar.init_settings(), and commotion_client.GUI.toolbar_builder.ToolBar.init_settings().

129  def load_extensions(self):
130  """Opens the extensions menu in the main viewport """
131  pass
def load_extensions
Definition: toolbar.py:128
def commotion_client.GUI.toolbar.ToolBar.load_settings (   self)
Opens the settings menu in the main viewport 

Referenced by commotion_client.GUI.toolbar.ToolBar.init_settings(), and commotion_client.GUI.toolbar_builder.ToolBar.init_settings().

109  def load_settings(self):
110  """Opens the settings menu in the main viewport """
111  pass
def load_settings
Definition: toolbar.py:108
def commotion_client.GUI.toolbar.ToolBar.load_update (   self)
Opens the updates menu in the main viewport 

Referenced by commotion_client.GUI.toolbar.ToolBar.init_settings(), and commotion_client.GUI.toolbar_builder.ToolBar.init_settings().

117  def load_update(self):
118  """Opens the updates menu in the main viewport """
119  pass
def load_update
Definition: toolbar.py:116
def commotion_client.GUI.toolbar.ToolBar.load_user (   self)
Opens the user menu in the main viewport 
121  def load_user(self):
122  """Opens the user menu in the main viewport """
123  pass
def load_user
Definition: toolbar.py:120

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