exclusive_options_group.py
Go to the documentation of this file.
00001 # Software License Agreement (BSD License)
00002 #
00003 # Copyright (c) 2012, Dorian Scholz
00004 # All rights reserved.
00005 #
00006 # Redistribution and use in source and binary forms, with or without
00007 # modification, are permitted provided that the following conditions
00008 # are met:
00009 #
00010 #  * Redistributions of source code must retain the above copyright
00011 #    notice, this list of conditions and the following disclaimer.
00012 #  * Redistributions in binary form must reproduce the above
00013 #    copyright notice, this list of conditions and the following
00014 #    disclaimer in the documentation and/or other materials provided
00015 #    with the distribution.
00016 #  * Neither the name of Willow Garage, Inc. nor the names of its
00017 #    contributors may be used to endorse or promote products derived
00018 #    from this software without specific prior written permission.
00019 #
00020 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00021 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023 # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00024 # COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00027 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00028 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00029 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00030 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00031 # POSSIBILITY OF SUCH DAMAGE.
00032 
00033 from python_qt_binding.QtGui import QButtonGroup, QGroupBox, QLabel, QRadioButton, QVBoxLayout, QWidget
00034 
00035 
00036 class ExclusiveOptionGroup(QGroupBox):
00037     """
00038     Creates a button group of exclusive radio options. 
00039 
00040     Options must be a dict with following keys: 'enabled','selected','title','description','tooltip'
00041     """
00042 
00043     def __init__(self, options, title='Exclusive Options', selected_index=None, parent=None):
00044         super(ExclusiveOptionGroup, self).__init__()
00045         self.setTitle(title)
00046         self.setLayout(QVBoxLayout())
00047         self._button_group = QButtonGroup()
00048         self._button_group.setExclusive(True)
00049         self._options = options
00050         if parent == None:
00051             parent = self
00052 
00053         for (button_id, option) in enumerate(self._options):
00054 
00055             radio_button = QRadioButton(option.get('title', 'option %d' % button_id))
00056             radio_button.setEnabled(option.get('enabled', True))
00057             radio_button.setChecked(option.get('selected', False) or button_id == selected_index)
00058             radio_button.setToolTip(option.get('tooltip', ''))
00059 
00060             self._button_group.addButton(radio_button, button_id)
00061             parent.layout().addWidget(radio_button)
00062             if 'description' in option:
00063                 parent.layout().addWidget(QLabel(option['description']))
00064 
00065     def get_settings(self):
00066         """Returns dictionary with selected_index (int) and selected_option (dict) keys."""
00067         selected_index = self._button_group.checkedId()
00068         if selected_index >= 0:
00069             return {'selected_index': selected_index, 'selected_option': self._options[selected_index]}
00070         return {'selected_index': None, 'selected_option': None}


qt_gui_py_common
Author(s): Dorian Scholz
autogenerated on Mon Oct 6 2014 03:57:55