225 lines
7.2 KiB
C++
225 lines
7.2 KiB
C++
/* _______ __ __ __ ______ __ __ _______ __ __
|
|
* / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
|
|
* / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
|
|
* / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
|
|
* / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
|
|
* /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
|
|
* \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
|
|
*
|
|
* Copyright (c) 2004, 2005, 2006, 2007 Olof Naessén and Per Larsson
|
|
*
|
|
* Js_./
|
|
* Per Larsson a.k.a finalman _RqZ{a<^_aa
|
|
* Olof Naessén a.k.a jansem/yakslem _asww7!uY`> )\a//
|
|
* _Qhm`] _f "'c 1!5m
|
|
* Visit: http://guichan.darkbits.org )Qk<P ` _: :+' .' "{[
|
|
* .)j(] .d_/ '-( P . S
|
|
* License: (BSD) <Td/Z <fP"5(\"??"\a. .L
|
|
* Redistribution and use in source and _dV>ws?a-?' ._/L #'
|
|
* binary forms, with or without )4d[#7r, . ' )d`)[
|
|
* modification, are permitted provided _Q-5'5W..j/?' -?!\)cam'
|
|
* that the following conditions are met: j<<WP+k/);. _W=j f
|
|
* 1. Redistributions of source code must .$%w\/]Q . ."' . mj$
|
|
* retain the above copyright notice, ]E.pYY(Q]>. a J@\
|
|
* this list of conditions and the j(]1u<sE"L,. . ./^ ]{a
|
|
* following disclaimer. 4'_uomm\. )L);-4 (3=
|
|
* 2. Redistributions in binary form must )_]X{Z('a_"a7'<a"a, ]"[
|
|
* reproduce the above copyright notice, #}<]m7`Za??4,P-"'7. ).m
|
|
* this list of conditions and the ]d2e)Q(<Q( ?94 b- LQ/
|
|
* following disclaimer in the <B!</]C)d_, '(<' .f. =C+m
|
|
* documentation and/or other materials .Z!=J ]e []('-4f _ ) -.)m]'
|
|
* provided with the distribution. .w[5]' _[ /.)_-"+? _/ <W"
|
|
* 3. Neither the name of Guichan nor the :$we` _! + _/ . j?
|
|
* names of its contributors may be used =3)= _f (_yQmWW$#( "
|
|
* to endorse or promote products derived - W, sQQQQmZQ#Wwa]..
|
|
* from this software without specific (js, \[QQW$QWW#?!V"".
|
|
* prior written permission. ]y:.<\.. .
|
|
* -]n w/ ' [.
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT )/ )/ !
|
|
* HOLDERS AND CONTRIBUTORS "AS IS" AND ANY < (; sac , '
|
|
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, ]^ .- %
|
|
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF c < r
|
|
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR aga< <La
|
|
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 5% )P'-3L
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR _bQf` y`..)a
|
|
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, ,J?4P'.P"_(\?d'.,
|
|
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES _Pa,)!f/<[]/ ?"
|
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT _2-..:. .r+_,.. .
|
|
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, ?a.<%"' " -'.a_ _,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ^
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
|
|
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
|
|
* IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#ifndef GCN_RADIOBUTTON_HPP
|
|
#define GCN_RADIOBUTTON_HPP
|
|
|
|
#include <map>
|
|
#include <string>
|
|
|
|
#include "guisan/keylistener.hpp"
|
|
#include "guisan/mouselistener.hpp"
|
|
#include "guisan/platform.hpp"
|
|
#include "guisan/widget.hpp"
|
|
|
|
namespace gcn
|
|
{
|
|
/**
|
|
* Implementation of a radio button where a user can select or deselect
|
|
* the radio button and where the status of the radio button is displayed to the user.
|
|
* A radio button can belong to a group and when a radio button belongs to a
|
|
* group only one radio button can be selected in the group. A radio button is
|
|
* capable of displaying a caption.
|
|
*
|
|
* If a radio button's state changes an action event will be sent to all action
|
|
* listeners of the check box.
|
|
*/
|
|
class GCN_CORE_DECLSPEC RadioButton :
|
|
public Widget,
|
|
public MouseListener,
|
|
public KeyListener
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* Constructor.
|
|
*/
|
|
RadioButton();
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param caption The caption of the radio button.
|
|
* @param group The group the radio button should belong to.
|
|
* @param selected True if the radio button should be selected.
|
|
*/
|
|
RadioButton(const std::string& caption,
|
|
const std::string& group,
|
|
bool selected = false);
|
|
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
virtual ~RadioButton();
|
|
|
|
/**
|
|
* Checks if the radio button is selected.
|
|
*
|
|
* @return True if the radio button is selecte, false otherwise.
|
|
* @see setSelected
|
|
*/
|
|
[[nodiscard]] bool isSelected() const;
|
|
|
|
/**
|
|
* Sets the radio button to selected or not.
|
|
*
|
|
* @param selected True if the radio button should be selected,
|
|
* false otherwise.
|
|
* @see isSelected
|
|
*/
|
|
void setSelected(bool selected);
|
|
|
|
/**
|
|
* Gets the caption of the radio button.
|
|
*
|
|
* @return The caption of the radio button.
|
|
* @see setCaption
|
|
*/
|
|
[[nodiscard]] const std::string& getCaption() const;
|
|
|
|
/**
|
|
* Sets the caption of the radio button. It's advisable to call
|
|
* adjustSize after setting of the caption to adjust the
|
|
* radio button's size to fit the caption.
|
|
*
|
|
* @param caption The caption of the radio button.
|
|
* @see getCaption, adjustSize
|
|
*/
|
|
void setCaption(std::string caption);
|
|
|
|
/**
|
|
* Sets the group the radio button should belong to. Note that
|
|
* a radio button group is unique per application, not per Gui object
|
|
* as the group is stored in a static map.
|
|
*
|
|
* @param group The name of the group.
|
|
* @see getGroup
|
|
*/
|
|
void setGroup(const std::string& group);
|
|
|
|
/**
|
|
* Gets the group the radio button belongs to.
|
|
*
|
|
* @return The group the radio button belongs to.
|
|
* @see setGroup
|
|
*/
|
|
[[nodiscard]] const std::string& getGroup() const;
|
|
|
|
/**
|
|
* Adjusts the radio button's size to fit the caption.
|
|
*/
|
|
void adjustSize();
|
|
|
|
|
|
// Inherited from Widget
|
|
|
|
void draw(Graphics* graphics) override;
|
|
|
|
void drawBorder(Graphics* graphics) override;
|
|
|
|
|
|
// Inherited from KeyListener
|
|
|
|
void keyPressed(KeyEvent& keyEvent) override;
|
|
|
|
|
|
// Inherited from MouseListener
|
|
|
|
void mouseClicked(MouseEvent& mouseEvent) override;
|
|
|
|
void mouseDragged(MouseEvent& mouseEvent) override;
|
|
|
|
protected:
|
|
/**
|
|
* Draws the box.
|
|
*
|
|
* @param graphics a Graphics object to draw with.
|
|
*/
|
|
virtual void drawBox(Graphics* graphics);
|
|
|
|
/**
|
|
* True if the radio button is selected, false otherwise.
|
|
*/
|
|
bool mSelected{};
|
|
|
|
/**
|
|
* Holds the caption of the radio button.
|
|
*/
|
|
std::string mCaption;
|
|
|
|
/**
|
|
* Holds the group of the radio button.
|
|
*/
|
|
std::string mGroup;
|
|
|
|
/**
|
|
* Typdef.
|
|
*/
|
|
typedef std::multimap<std::string, RadioButton*> GroupMap;
|
|
|
|
/**
|
|
* Typdef.
|
|
*/
|
|
typedef GroupMap::iterator GroupIterator;
|
|
|
|
/**
|
|
* Holds all available radio button groups.
|
|
*/
|
|
static GroupMap mGroupMap;
|
|
};
|
|
}
|
|
|
|
#endif // end GCN_RADIOBUTTON_HPP
|