Back to index

nux  3.0.0
RadioButtonGroup.h
Go to the documentation of this file.
00001 /*
00002  * Copyright 2010 Inalogic® Inc.
00003  *
00004  * This program is free software: you can redistribute it and/or modify it
00005  * under the terms of the GNU Lesser General Public License, as
00006  * published by the  Free Software Foundation; either version 2.1 or 3.0
00007  * of the License.
00008  *
00009  * This program is distributed in the hope that it will be useful, but
00010  * WITHOUT ANY WARRANTY; without even the implied warranties of
00011  * MERCHANTABILITY, SATISFACTORY QUALITY or FITNESS FOR A PARTICULAR
00012  * PURPOSE.  See the applicable version of the GNU Lesser General Public
00013  * License for more details.
00014  *
00015  * You should have received a copy of both the GNU Lesser General Public
00016  * License along with this program. If not, see <http://www.gnu.org/licenses/>
00017  *
00018  * Authored by: Jay Taoko <jaytaoko@inalogic.com>
00019  *
00020  */
00021 
00022 
00023 #ifndef RADIOBUTTONLOGIC_H
00024 #define RADIOBUTTONLOGIC_H
00025 
00026 namespace nux
00027 {
00028 
00029   class RadioButton;
00030 
00032 
00035   class RadioButtonGroup: public InitiallyUnownedObject
00036   {
00037     NUX_DECLARE_OBJECT_TYPE(RadioButtonGroup, InitiallyUnownedObject);
00038   public:
00039     RadioButtonGroup(NUX_FILE_LINE_PROTO);
00040     ~RadioButtonGroup();
00041 
00043     /*
00044         The first radio button added to the group gets its check state set to true.
00045         When a radio button is added to a group that is not empty, its check state is set to false.
00046     */
00047     void ConnectButton(RadioButton* radio);
00048 
00050     /*
00051         When a radio button is removed, the previous button in the group gets its check state set to true;
00052     */
00053     void DisconnectButton(RadioButton* radio);
00054 
00056     /*
00057         Set the active radio button in the group. If \i emit_signal is true, all the button in the group
00058         emit their \i state_changed signal.\n
00059         If the parameter \i radio is already active and \i emit_signal is true, the \i state_changed signal will be emitted.\n
00060         The active button is the last one to emit its \i state_changed signal.
00061 
00062         @param radio The button to activate.
00063         @param emit_signal If true, emit the state_changed signal of all the buttons in the group.
00064     */
00065     void SetActiveButton(RadioButton* radio, bool emit_signal = true);
00066 
00067   private:
00069 
00074     int GetNumButtons();
00075     void NotifyClick(RadioButton* radio);
00076     std::vector<ObjectWeakPtr<RadioButton> > radio_button_array_;
00077     int active_button_index_;
00078 
00079     friend class RadioButton;
00080   };
00081 
00082 
00083 }
00084 
00085 #endif // RADIOBUTTONLOGIC_H