RadioGroup.H

/* RadioGroup.H */
/* $Revision: 1.10 $    RadioGroup.H    $Date: 2004/08/17 14:07:14 $ */
#ifndef __RadioGroup_H
#define __RadioGroup_H


/*************************************************************
 * Group of states with rule ``ONE OF MANY''.
 * Each state is identified by programmer defined number (any).
 * Each state have 0 or more control elements (widgets).
 * When state is being changed, NewStateHook is called.
 * Visual state of control element is mainteined by
 * ChangeArmState() function.  It's assumed that all control
 * elements are disarmed when added into RadioGroup.
 * Do not change its states manually!!!
 * When a programmer add new state object check it for
 * uniquiness and do not duplicate state.  When programmer
 * try to set unknown state  or want to add control to unknown
 * state -- be silent.
 *************************************************************/

#include <X11/Intrinsic.h>
#include <mix/IntAr.H>


/* Forward descriptions */
class ZtObject;
class QfBrick;


/* State handle procedure */
typedef void (*RadioHandleProc)(int idPrevState, int idNewState);


/*************************************************************
 * Description of each control element.
 *************************************************************/
struct RadioControlElement
{
  int       state;  /* state id */
  Widget    w;  /* Widget is a control element  */
  ZtObject  *z; /* ZtObject is a control element */
  QfBrick   *q; /* QfBrick is a control element */
  Widget    w_optm; /* Widget of OptionMenu or NULL if w is not an
                           item in Option Menu */
};


/*************************************************************
 * Array of control elements with sorting by widget.
 *************************************************************/
#define AnyType     RadioControlElement
#define AnyAr       ArrayOfRCE
#define AnyCmp(x,y) (!((x.w == y.w) && (x.z == y.z) && (x.q == y.q)))
#define AnyFormatSpec   "\n%d @ state=%d: w=%p; z=%p; q=%p"
#define AnyPrintList    i, item.state, item.w, item.z, item.q
#include <mix/AnyAr.H>


class RadioGroup
{
protected:

  /* Current active state */
  int       state;

  /* Array of states */
  IntAr     states;

  /* Array of control elements */
  ArrayOfRCE    controls;

  /* Current active state */
  RadioHandleProc   event_handler;

  /* Change state of pointed control element */
  void  ChangeState (unsigned i);

  /* Remove control entry from all states */
  void  RemoveAnyControl (void* ptr);

  /* Set current state of option menu item w */
  static void   SetCurrentInOptionMenu (Widget w, Widget w_optm);


  /*************************************************************
   * Callbacks for control elements.
   *************************************************************/

  static void
    UniversalCB (Widget w, RadioGroup* self, XtPointer pCallData);
  static void
    ToggleButtonCB (Widget w, RadioGroup* self, XtPointer pCallData);
  static void
    DrawnButtonCB (Widget w, RadioGroup* self, XtPointer pCallData);
  static void
    PushButtonCB (Widget w, RadioGroup* self, XtPointer pCallData);
  static void
    OptionMenuButtonCB (Widget w, RadioGroup* self, XtPointer pCallData);

public:

  RadioGroup ();

  /* Register the only event handler for this radio group */
  void  SetHandler (RadioHandleProc handler);
  void  ResetHandler ();

  void  AddState (int idState);
  void  AddControl (int idState, Widget w, Widget w_optm = NULL);
  void  AddControl (int idState, ZtObject* zobj);
  void  AddControl (int idState, QfBrick* qobj);

  void  SetState (int idState);
  int   GetState () const
    {return state;}

  void  RemoveState (int idState);
  void  RemoveControl (Widget w);
  void  RemoveControl (ZtObject* zobj);
  void  RemoveControl (QfBrick* qobj);

  virtual void  NewStateHook (int idPrevState, int idNewState);

};


#endif /* RadioGroup.H */