scripter_hooks.MenuHooks Class Reference

Inheritance diagram for scripter_hooks.MenuHooks:

Public Member Functions
	__init__ (self, window=None)
	actionForMenu (self, menu)
	appendItem (self, menu, item, *extra_args)
	appendMenu (self, menu)
	appendSeparator (self, menu)
	createMenu (self, title)
	findMenu (self, title)
	insertMenuAfter (self, after_menu, new_menu)
	insertMenuBefore (self, before_menu, new_menu)
	iter_inner_menus (self, menu)
	iter_menus (self)
	menuAfter (self, menu)

Public Attributes
	menubar
	menus
	window

Detailed Description

This class lets extension-scripts hook into the main menu of Scribus.

Definition at line 22 of file scripter_hooks.py.

Constructor & Destructor Documentation

__init__()

scripter_hooks.MenuHooks.__init__	(		self,
			window = None )

Definition at line 28 of file scripter_hooks.py.

    def __init__(self, window=None):
        self.window = window or Scripter.dialogs.mainWindow.qt
        self.menubar = self.window.menuBar()
        self.menus = []
 

Member Function Documentation

actionForMenu()

scripter_hooks.MenuHooks.actionForMenu	(		self,
			menu )

Definition at line 69 of file scripter_hooks.py.

    def actionForMenu(self, menu):
        for action in self.menubar.actions():
            if action.menu() == menu:
                return action
 

References scripter_hooks.MenuHooks.menubar, and krita.sceditor.mainwindow_ui.Ui_ScriptEditor.menubar.

appendItem()

scripter_hooks.MenuHooks.appendItem	(		self,
			menu,
			item,
		*	extra_args )

Definition at line 120 of file scripter_hooks.py.

    def appendItem(self, menu, item, *extra_args):
        if isinstance(menu, basestring):
            title = menu
            menu = self.findMenu(title)
            if not menu:
                raise ValueError("Menu %r not found" % title)
        if isinstance(item, QMenu):
            action = menu.addMenu(item)
        else:
            action = menu.addAction(item, *extra_args)
        return action
 

References scripter_hooks.MenuHooks.findMenu().

appendMenu()

scripter_hooks.MenuHooks.appendMenu	(		self,
			menu )

  Probably not that useful
  because it will add a menu after the help menu

Definition at line 100 of file scripter_hooks.py.

    def appendMenu(self, menu):
        """
          Probably not that useful
          because it will add a menu after the help menu
        """
        action = self.menubar.addMenu(menu)
        return action
 

References scripter_hooks.MenuHooks.menubar, and krita.sceditor.mainwindow_ui.Ui_ScriptEditor.menubar.

appendSeparator()

scripter_hooks.MenuHooks.appendSeparator	(		self,
			menu )

Definition at line 132 of file scripter_hooks.py.

    def appendSeparator(self, menu):
        if isinstance(menu, basestring):
            menu = self.findMenu(menu)
        menu.addSeparator()

References scripter_hooks.MenuHooks.findMenu().

createMenu()

scripter_hooks.MenuHooks.createMenu	(		self,
			title )

Definition at line 33 of file scripter_hooks.py.

    def createMenu(self, title):
        m = QMenu(title)
        self.menus.append(m)
        self.menubar.addMenu(m)
        return m
 

References scripter_hooks.MenuHooks.menubar, krita.sceditor.mainwindow_ui.Ui_ScriptEditor.menubar, and scripter_hooks.MenuHooks.menus.

findMenu()

scripter_hooks.MenuHooks.findMenu	(		self,
			title )

find a menu with a given title

@type  title: string
@param title: English title of the menu
@rtype:       QMenu
@return:      None if no menu was found, else the menu with title

Definition at line 51 of file scripter_hooks.py.

    def findMenu(self, title):
        """
        find a menu with a given title
 
        @type  title: string
        @param title: English title of the menu
        @rtype:       QMenu
        @return:      None if no menu was found, else the menu with title
        """
        # See also http://pyqt.sourceforge.net/Docs/PyQt5/i18n.html#differences-between-pyqt5-and-qt
        title = QApplication.translate(mikro.classname(self.window), title)
        for menu in self.iter_menus():
            if menu.title() == title:
                return menu
            for innerMenu in self.iter_inner_menus(menu):
                if innerMenu.title() == title:
                    return innerMenu
 

References scripter_hooks.MenuHooks.iter_inner_menus(), scripter_hooks.MenuHooks.iter_menus(), KisMemoryWindow::MappingWindow.window, KisTheme.window(), View.window(), Window::Private.window, KoStorePrivate.window, and scripter_hooks.MenuHooks.window.

insertMenuAfter()

scripter_hooks.MenuHooks.insertMenuAfter	(		self,
			after_menu,
			new_menu )

Insert a menu before another menu in the menubar

Definition at line 108 of file scripter_hooks.py.

    def insertMenuAfter(self, after_menu, new_menu):
        """
        Insert a menu before another menu in the menubar
        """
        if isinstance(after_menu, basestring):
            after_menu = self.findMenu(after_menu)
        after_after_menu = self.menuAfter(after_menu)
        if after_after_menu:
            return self.insertMenuBefore(after_after_menu, new_menu)
        else:
            return self.appendMenu(new_menu)
 

References scripter_hooks.MenuHooks.appendMenu(), scripter_hooks.MenuHooks.findMenu(), scripter_hooks.MenuHooks.insertMenuBefore(), and scripter_hooks.MenuHooks.menuAfter().

insertMenuBefore()

scripter_hooks.MenuHooks.insertMenuBefore	(		self,
			before_menu,
			new_menu )

Insert a menu after another menu in the menubar

@type: before_menu QMenu instance or title string of menu
@param before_menu: menu which should be after the newly inserted menu
@rtype: QAction instance
@return: action for inserted menu

Definition at line 74 of file scripter_hooks.py.

    def insertMenuBefore(self, before_menu, new_menu):
        """
        Insert a menu after another menu in the menubar
 
        @type: before_menu QMenu instance or title string of menu
        @param before_menu: menu which should be after the newly inserted menu
        @rtype: QAction instance
        @return: action for inserted menu
        """
        if isinstance(before_menu, basestring):
            before_menu = self.findMenu(before_menu)
        before_action = self.actionForMenu(before_menu)
        # I have no clue why QMenuBar::insertMenu only allows
        # to insert before another menu and not after a menu...
        new_action = self.menubar.insertMenu(before_action, new_menu)
        return new_action
 

References scripter_hooks.MenuHooks.actionForMenu(), scripter_hooks.MenuHooks.findMenu(), scripter_hooks.MenuHooks.menubar, and krita.sceditor.mainwindow_ui.Ui_ScriptEditor.menubar.

iter_inner_menus()

scripter_hooks.MenuHooks.iter_inner_menus	(		self,
			menu )

Definition at line 45 of file scripter_hooks.py.

    def iter_inner_menus(self, menu):
        for action in menu.actions():
            menu = action.menu()
            if menu:
                yield menu
 

iter_menus()

scripter_hooks.MenuHooks.iter_menus

(

self

)

Definition at line 39 of file scripter_hooks.py.

    def iter_menus(self):
        for action in self.menubar.actions():
            menu = action.menu()
            if menu:
                yield menu
 

References scripter_hooks.MenuHooks.menubar, and krita.sceditor.mainwindow_ui.Ui_ScriptEditor.menubar.

menuAfter()

scripter_hooks.MenuHooks.menuAfter	(		self,
			menu )

Definition at line 91 of file scripter_hooks.py.

    def menuAfter(self, menu):
        # This method is needed for insertMenuAfter because
        # QMenuBar.insertMenu can only insert before another menu
        previous = None
        for m in self.iter_menus():
            if previous and previous == menu:
                return m
            previous = m
 

References scripter_hooks.MenuHooks.iter_menus().

Member Data Documentation

menubar

scripter_hooks.MenuHooks.menubar

Definition at line 30 of file scripter_hooks.py.

menus

scripter_hooks.MenuHooks.menus

Definition at line 31 of file scripter_hooks.py.

window

scripter_hooks.MenuHooks.window

Definition at line 29 of file scripter_hooks.py.

---

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

• plugins/extensions/pykrita/plugin/krita/attic/scripter_hooks.py