radio_box.h

Go to the documentation of this file.

#ifndef RADIO_BOX_CLASS
#define RADIO_BOX_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : radio_box                                                         *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*  Purpose:                                                                   *
*                                                                             *
*    Allow a user to choose a button from a mutually exclusive set of         *
*  buttons.                                                                   *
*                                                                             *
*                                                                             *
*******************************************************************************
* Copyright (c) 1991-$now By Author.  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 is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

// Description:
//
//   A radio box is a window filled with radio buttons.  A radio button is
//   an object that the user can press to turn on.  Only one radio button is
//   turned on at a time.  When the user selects a radio button, that one is
//   turned on and the previously on button is turned off.  When the user
//   selects a button, the event function button_press_event is invoked.

#include "mouse.h"

#include <basis/istring.h>
#include <wp_passive/worker.h>

class radio_box_button;

enum radio_box_outcomes { RB_NO_BUTTON = -1 };

class WP_ACTIVE_CLASS_STYLE radio_box
: public worker, private array<radio_box_button *>
{
public:
  radio_box(manager &parent, const c_point &origin,
          const color &foreground, const color &background);
    // Creates a radio box.  This supplements the abstraction provided by Motif
    // radio boxes.  The application creates a radio and can add buttons to it.
    // Then the user of the application can press the buttons.  The event
    // function button_pressed is called when the user presses a button.
    // The user can assume that the the selected button is the ONLY button that
    // is "on" (i.e. all other buttons are off).

  ~radio_box();

  IMPLEMENT_CLASS_NAME("radio_box");

  int add(const istring &button_name);
    // Attaches a new button to this radio box.  The button number for this
    // "button_name" is returned.  By default, the first button added to the
    // radio_box is selected.  Note that button names should be unique.

  void press(int button_number, bool trigger_event = true);
    // Imitates the action that occurs when a user presses the specified
    // button.  If "trigger_event" is true, then the button_event
    // method is also invoked.  Otherwise, only the appearance of the radio box
    // is changed to reflect the button being pressed (and none of the other's
    // being pressed).

  virtual void button_event(int button_number);
    // this is called when the user selects a button from the radio box.
    // the button selected is passed in "pressed".

  int current() const;
    // returns the number of the button currently selected in the box.
    // RB_NO_BUTTON is returned if there are no buttons yet.

  int lookup(const istring &to_find) const;
    // returns the index of the button in the button list or RB_NO_BUTTON
    // if the button could not be found.

  istring lookup(int index) const;
    // returns the name for the button at "index", or an empty string if that
    // index is not valid.

  int buttons() const;
    // returns the current number of buttons in the radio_box.

  static void radio_box_callback(window_handle w, radio_box_button *the_button,
          XmToggleButtonCallbackStruct *);

private:
  radio_box_button *active;
  mouse *touched_box_manager;
};

class WP_ACTIVE_CLASS_STYLE radio_box_button : public worker
{
public:
  radio_box_button(radio_box *parent, const istring &button_name, int number);
  ~radio_box_button();

private:
  istring _name;
  int button_number;
  bool interactive_press;
  friend class radio_box;
  radio_box *_parent;
};

#endif

---