Source code for tools.examples.examplePlugin

#!/usr/bin/env python
# -*- coding: UTF-8 -*-

""" Module examplePlugin: This module is an example of how to create a plugin in Mari. """

# noinspection PyUnresolvedReferences
import mari
from PySide import QtGui
from stkMariTools.lib.ui_utils import MariToolsMenuItem, MariWidget


class ExampleMenuItem(MariToolsMenuItem):
    """
    This class adds the action.
    """

    def __init__(self):
        """
        The constructor.

        :return:
        """

        # Call base constructor
        super(ExampleMenuItem, self).__init__()

        # Set the class instance in order for the action command to be
        # able to be set in the namespace correctly.
        mari.ExampleMenuItem = self

        # Action item is to be called in the Menu
        self.actionIdentifier = 'Launch Example Plugin'

        # Python command to be run when action is executed from the Menu
        self.actionCommand = 'mari.ExampleMenuItem.doIt()'

        # Path to the action in the Mari Menu
        self.actionPath = 'MainWindow/&Scripts/Examples'

        # Icon to use for the action
        self.actionIcon = 'About'

        # Register the plugin
        self.addMariToolsMenuItem()


    def doIt(self):

        ExampleWidget()


class ExampleWidget(MariWidget):
    """
    This class instantiates a example widget.
    """

    def __init__(self, title='Example Widget'):
        """
        The constructor.

        :return:
        """

        self.closeButton = None

        # Call base constructor
        super( ExampleWidget, self ).__init__(title=title)


    def defineUi(self):
        """
        This method should be overloaded to handle defining the actual UI interface.
        It is run before populateData() and makeConnections().

        :return:
        """

        layout = QtGui.QVBoxLayout()

        checkbox = QtGui.QCheckBox('Show title', self)

        button = QtGui.QPushButton('Push Me')
        self.closeButton = QtGui.QPushButton('Close')

        self.setGeometry(300, 300, 250, 150)

        layout.addWidget(checkbox)
        layout.addWidget(button)
        layout.addWidget(self.closeButton)

        self.widget_holder.setLayout(layout)


    def makeConnections(self, *args, **kwargs):
        """
        Connects the UI controls to callback signals.

        :param args:
        :param kwargs:
        :return:
        """

        # Close button
        self.closeButton.clicked.connect(self.cancelAction)