From 7a6f5b2c1d83fe62c62f0c30cad28eb091d52dfe Mon Sep 17 00:00:00 2001 From: necoro <> Date: Fri, 20 Apr 2007 14:44:45 +0000 Subject: Made qt plugin-ready; lots of documentation --- portato/gui/gtk/windows.py | 2 +- portato/gui/gui_helper.py | 6 ++- portato/gui/qt/helper.py | 13 +++++ portato/gui/qt/highlighter.py | 74 ++++++++++++++++++++++++--- portato/gui/qt/terminal.py | 71 ++++++++++++++++++++------ portato/gui/qt/ui/AboutDialog.ui | 105 ++++++++++++++++++++++++++++++--------- portato/gui/qt/ui/MainWindow.ui | 12 ++--- portato/gui/qt/windows.py | 67 +++++++++++++++++++++++-- 8 files changed, 293 insertions(+), 57 deletions(-) (limited to 'portato/gui') diff --git a/portato/gui/gtk/windows.py b/portato/gui/gtk/windows.py index d2151ab..5aeceed 100644 --- a/portato/gui/gtk/windows.py +++ b/portato/gui/gtk/windows.py @@ -757,7 +757,7 @@ class MainWindow (Window): self.cfg.modify_external_configs() # set plugins and plugin-menu - plugin.load_plugins() + plugin.load_plugins("gtk") menus = plugin.get_plugins().get_plugin_menus() if menus: self.tree.get_widget("pluginMenuItem").set_no_show_all(False) diff --git a/portato/gui/gui_helper.py b/portato/gui/gui_helper.py index e52b3f3..5cc2ee6 100644 --- a/portato/gui/gui_helper.py +++ b/portato/gui/gui_helper.py @@ -30,7 +30,7 @@ import time import os import signal -class Config: +class Config: # XXX: This needs to be replaced - the const-dict is just messy """Wrapper around a ConfigParser and for additional local configurations.""" const = { "main_sec" : "Main", @@ -263,7 +263,9 @@ class EmergeQueue: @param console: Output is shown here. @type console: Console @param db: A database instance. - @type db: Database""" + @type db: Database + @param title_update: A function, which will be called whenever there is a title update. + @type title_update: function(string)""" # the different queues self.mergequeue = [] # for emerge diff --git a/portato/gui/qt/helper.py b/portato/gui/qt/helper.py index 1b7dbdc..fa1576a 100644 --- a/portato/gui/qt/helper.py +++ b/portato/gui/qt/helper.py @@ -13,10 +13,23 @@ from PyQt4 import Qt def qCheck (check): + """Maps True or False to Qt.Checked or Qt.Unchecked. + + @param check: boolean value + @type check: bool + @returns: CheckState-Constant + @rtype: int""" + if check: return Qt.Qt.Checked else: return Qt.Qt.Unchecked def qIsChecked (check): + """Maps Qt.Checked and Qt.Unchecked to True and False. + + @param check: CheckState-Constant + @type check: int + @returns: appropriate boolean value + @rtype: bool""" return check == Qt.Qt.Checked diff --git a/portato/gui/qt/highlighter.py b/portato/gui/qt/highlighter.py index 5572930..74d9ac9 100644 --- a/portato/gui/qt/highlighter.py +++ b/portato/gui/qt/highlighter.py @@ -19,30 +19,59 @@ from portato.helper import debug import re # prefer Python-Module over Qt-one class EbuildHighlighter (Qt.QSyntaxHighlighter): + """A QSyntaxHighlighter implementation for the use with ebuild-syntax.""" NORMAL_STATE = 0 STRING_STATE = 1 def __init__ (self, edit): + """Constructor. + + @param edit: the EditWidget to use the highlighter with + @type edit: Qt.QTextEdit""" + Qt.QSyntaxHighlighter.__init__(self, edit) + # + # the regular expressions ... *muahahaha* + # + + # comments self.comment = self.__create(r'#.*', color = "steelblue", italic = True) + + # bash variables self.bashVar = self.__create(r'(\$\{.+?\})|(\$\w+)', color = "green") + # a string + self.string = self.__create(r'(? reload format self.setCurrentCharFormat(self.get_format()) else: @@ -97,13 +114,16 @@ class QtConsole (Console, Qt.QTextEdit): self.ensureCursorVisible() def write(self, text): + """Convenience function for emitting the writing signal.""" self.emit(Qt.SIGNAL("doSomeWriting"), text) def start_new_thread (self): - self.run = True - self.current = Thread(target=self.__run, name="QtTerminal Listener") - self.current.setDaemon(True) # close application even if this thread is running - self.current.start() + """Starts a new thread, which will listen for some input. + @see: QtTerminal.__run()""" + self.run = True + self.current = Thread(target=self.__run, name="QtTerminal Listener") + self.current.setDaemon(True) # close application even if this thread is running + self.current.start() def set_pty (self, pty): if not self.running: @@ -111,21 +131,22 @@ class QtConsole (Console, Qt.QTextEdit): self.start_new_thread() self.running = True - else: - # quit current thread + else: # quit current thread self.run = False - # self.current.join() self.clear() self.pty = pty # set this after clearing to lose no chars :) self.start_new_thread() def __run (self): + """This function is mainly a loop, which looks for some new input at the terminal, + and parses it for text attributes.""" + while self.run: s = read(self.pty, 1) - if s == "": break + if s == "": break # nothing read -> finish - if ord(s) == backspace: + if ord(s) == backspace: # BS self.emit(Qt.SIGNAL("deletePrevChar()")) continue @@ -154,9 +175,16 @@ class QtConsole (Console, Qt.QTextEdit): self.write(s) def parse_seq (self, seq): - global attr + """Parses a sequence of bytes. + If a new attribute has been encountered, a new format is created and added + to the internal format queue. + + @param seq: sequence to parse + @type seq: string""" + + global attr # the dict of attributes - format = self.virgin_format() + format = self.virgin_format() if seq != reset_seq: # resettet -> done seq = seq.split(seq_sep) @@ -178,10 +206,9 @@ class QtConsole (Console, Qt.QTextEdit): break self.add_format(format) - self.write(esc_seq[0]) + self.write(esc_seq[0]) # write \x1b to signal the occurence of a new format def parse_title (self, seq): - if not seq.startswith("0;"): return @@ -191,15 +218,31 @@ class QtConsole (Console, Qt.QTextEdit): return self.title def add_format (self, format): + """Adds a format to the queue. + We have to take a queue, because the write-signals might occur asynchronus, + so we set a format for the wrong characters. + + @param format: the format to add + @type format: Qt.QTextCharFormat""" + self.formatLock.acquire() self.formatQueue.append(format) self.formatLock.release() def get_format (self): + """Returns a format from the queue. + We have to take a queue, because the write-signals might occur asynchronus, + so we set a format for the wrong characters. + + @returns: the popped format + @rtype: Qt.QTextCharFormat""" + self.formatLock.acquire() f = self.formatQueue.pop(0) self.formatLock.release() return f def virgin_format (self): + """The normal standard format. It is necessary to create it as a new one for some + dubious reasons ... only Qt.QGod knows why.""" return Qt.QTextCharFormat(self.stdFormat) diff --git a/portato/gui/qt/ui/AboutDialog.ui b/portato/gui/qt/ui/AboutDialog.ui index 5ed35e2..1424270 100644 --- a/portato/gui/qt/ui/AboutDialog.ui +++ b/portato/gui/qt/ui/AboutDialog.ui @@ -9,7 +9,7 @@ 0 0 369 - 279 + 270 @@ -23,31 +23,90 @@ 6 - - - TextLabel - - - Qt::AlignCenter - - - true + + + 0 + + + About + + + + 9 + + + 6 + + + + + TextLabel + + + Qt::AlignCenter + + + true + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + Plugins + + + + 9 + + + 6 + + + + + QAbstractItemView::NoEditTriggers + + + false + + + false + + + 2 + + + + 1 + + + + + 1 + + + + + + - - - - Qt::Vertical - - - - 20 - 40 - - - - diff --git a/portato/gui/qt/ui/MainWindow.ui b/portato/gui/qt/ui/MainWindow.ui index 80c5c12..5b8d0d9 100644 --- a/portato/gui/qt/ui/MainWindow.ui +++ b/portato/gui/qt/ui/MainWindow.ui @@ -403,7 +403,7 @@ p, li { white-space: pre-wrap; } 27 - + &File @@ -412,13 +412,13 @@ p, li { white-space: pre-wrap; } - + &? - + &Emerge @@ -431,9 +431,9 @@ p, li { white-space: pre-wrap; } - - - + + + diff --git a/portato/gui/qt/windows.py b/portato/gui/qt/windows.py index f6d5103..3fa93cf 100644 --- a/portato/gui/qt/windows.py +++ b/portato/gui/qt/windows.py @@ -22,6 +22,9 @@ from portato.backend.exceptions import * from portato.gui.gui_helper import Database, Config, EmergeQueue +# plugins +from portato import plugin + # own GUI stuff from terminal import QtConsole from tree import QtTree @@ -34,6 +37,10 @@ import types UI_DIR = DATA_DIR+"ui/" class WindowMeta (sip.wrappertype, type): + """This is the metaclass of all Qt-Windows. It automatically + sets the correct base classes, so they do not have to be set + by the programmer. + @attention: The class has to have the same name as the .ui-file.""" def __new__ (cls, name, bases, dict): new_bases = uic.loadUiType(UI_DIR+name+".ui") @@ -47,6 +54,8 @@ class WindowMeta (sip.wrappertype, type): super(WindowMeta, cls).__init__(name, b+bases, dict) class Window (object): + """Base class of all Qt-Windows. + Sets up the UI and provides the watch_cursor function.""" def __init__(self, parent = None): self._qt_base.__init__(self, parent) @@ -72,7 +81,14 @@ class AboutDialog (Window): """A window showing the "about"-informations.""" __metaclass__ = WindowMeta - def __init__ (self, parent = None): + def __init__ (self, parent = None, plugins = []): + """Constructor. + + @param parent: the parent window + @type parent: Qt.QWidget + @param plugins: The list of plugins (author,name) to show in the "Plugins"-Tab. + @type plugins: (string, string)[]""" + Window.__init__(self, parent) self.label.setText(""" @@ -84,6 +100,13 @@ Copyright (C) 2006-2007 René 'Necoro' Neumann <necoro@necoro.net> Thanks to Fred for support and ideas :P""" % VERSION) + self.pluginList.setHeaderLabels(["Plugin", "Author"]) + + for p in plugins: + Qt.QTreeWidgetItem(self.pluginList, list(p)) + + self.pluginList.resizeColumnToContents(0) + self.adjustSize() class SearchDialog (Window): @@ -114,10 +137,16 @@ class SearchDialog (Window): self.jumpTo(s) class EbuildDialog (Window): - + """Window showing an ebuild.""" __metaclass__ = WindowMeta def __init__ (self, parent, package): + """Constructor. + + @param parent: parent window + @type parent: Qt.QWidget + @param package: The package to show the ebuild of. + @type package: backend.Package""" Window.__init__(self, parent) @@ -164,11 +193,18 @@ class PreferenceWindow (Window): } def __init__ (self, parent, cfg): + """Constructor. + + @param parent: parent window + @type parent: Qt.QWidget + @param cfg: the actual configuration + @type cfg: Config""" Window.__init__(self, parent) self.cfg = cfg + # set hintLabel background palette = self.hintLabel.palette() palette.setColor(Qt.QPalette.Active, Qt.QPalette.Window, Qt.QColor(Qt.Qt.yellow)) self.hintLabel.setPalette(palette) @@ -213,6 +249,7 @@ class PreferenceWindow (Window): io_ex_dialog(self, e) class PackageDetails: + """The tab showing the details of a package.""" def __init__ (self, window): self.window = window @@ -288,6 +325,8 @@ class PackageDetails: self.window.tabWidget.setCurrentIndex(self.window.PKG_PAGE) def set_combo (self): + """Fills the version combo box with the right items and selects the correct one.""" + self.window.versCombo.clear() self.window.versCombo.addItems([x.get_version() for x in self.packages]) @@ -305,6 +344,7 @@ class PackageDetails: self.window.versCombo.setCurrentIndex(0) def build_use_list (self): + """Builds the list of use flags.""" self.window.useList.clear() self.window.useList.setHeaderLabels(["Enabled","Flag","Description"]) @@ -461,6 +501,10 @@ class PackageDetails: def cb_combo_changed (self): """Callback for the changed ComboBox. It then rebuilds the useList and the checkboxes.""" + + # + # ATTENTION: BIG'n'DIRTY :) + # # build new self.build_use_list() @@ -522,6 +566,7 @@ class PackageDetails: self.window.pkgUnmergeBtn.setEnabled(True) class MainWindow (Window): + """The application's main window.""" __metaclass__ = WindowMeta @@ -552,6 +597,16 @@ class MainWindow (Window): self.cfg.modify_external_configs() + # set plugins and plugin-menu + plugin.load_plugins("qt") + menus = plugin.get_plugins().get_plugin_menus() + if menus: + self.pluginMenu = Qt.QMenu("&Plugins") + self.menubar.insertMenu(self.helpMenu.menuAction(), self.pluginMenu) + for m in menus: + action = self.pluginMenu.addAction(m.label.replace("_","&")) + Qt.QObject.connect(action, Qt.SIGNAL("triggered()"), m.call) + # the two lists self.build_cat_list() Qt.QObject.connect(self.selCatListModel, Qt.SIGNAL("currentChanged(QModelIndex, QModelIndex)"), self.cb_cat_list_selected) @@ -624,7 +679,13 @@ class MainWindow (Window): @Qt.pyqtSignature("") def on_aboutAction_triggered (self): - AboutDialog(self).exec_() + queue = plugin.get_plugins() + if queue is None: + queue = [] + else: + queue = queue.get_plugin_data() + + AboutDialog(self, queue).exec_() @Qt.pyqtSignature("") def on_prefAction_triggered (self): -- cgit v1.2.3-54-g00ecf