kde-playground/kdepim/kalarm/lib/buttongroup.h
Ivailo Monev a9b00154bc generic: replace forward class declarations with header inclusions
Signed-off-by: Ivailo Monev <xakepa10@laimg.moc>
2019-07-31 18:05:48 +00:00

93 lines
3.3 KiB
C++

/*
* buttongroup.h - QButtonGroup with an extra signal, and button IDs
* Program: kalarm
* Copyright © 2002,2004,2005,2008 by David Jarvie <djarvie@kde.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef BUTTONGROUP_H
#define BUTTONGROUP_H
#include <QButtonGroup>
#include <QMap>
#include <QAbstractButton>
/**
* @short A QButtonGroup with signal on new selection, and button IDs.
*
* The ButtonGroup class provides an enhanced version of the QButtonGroup class.
*
* It emits an additional signal, buttonSet(QAbstractButton*), whenever any of its
* buttons changes state, for whatever reason, including programmatic control. (The
* QButtonGroup class only emits signals when buttons are clicked on by the user.)
*
* It allows buttons to have associated ID numbers, which can be used to access the
* buttons.
*
* @author David Jarvie <djarvie@kde.org>
*/
class ButtonGroup : public QButtonGroup
{
Q_OBJECT
public:
/** Constructor.
* @param parent The parent object of this widget
*/
explicit ButtonGroup(QObject* parent);
/** Adds a button to the group.
* The button is not given an ID.
* This overrides the addButton() method of QButtonGroup.
* @param button The button to insert
*/
void addButton(QAbstractButton* button);
/** Adds a button with a specified ID to the group.
* @param button The button to insert
* @param id Button ID
*/
void addButton(QAbstractButton* button, int id);
/** Returns the identifier of the specified button.
* @return ID, or -1 if the button was not found
*/
int id(QAbstractButton* button) const;
/** Returns the button with the specified identifier @p id.
* @return button, or 0 if the button was not found
*/
QAbstractButton* find(int id) const;
/** Returns the id of the selected button.
* @return button if exactly one is selected, or -1 otherwise
*/
int selectedId() const;
/** Checks the button with the specified ID.
* @param id Button ID
*/
void setButton(int id);
signals:
/** Signal emitted whenever whenever any button in the group changes state,
* for whatever reason.
* @param button The button which is now selected
*/
void buttonSet(QAbstractButton* button);
private slots:
void slotButtonToggled(bool);
private:
QMap<int, QAbstractButton*> mIds;
};
#endif // BUTTONGROUP_H
// vim: et sw=4: