/*****************************************************************************
#   Copyright (C) 1994-2008 by David Gordon.
#   All rights reserved.                           
#                                                                           
#   This software is part of a beta-test version of the Consed/Autofinish
#   package.  It should not be redistributed or
#   used for any commercial purpose, including commercially funded
#   sequencing, without written permission from the author and the
#   University of Washington.
#   
#   This software is provided ``AS IS'' and any express or implied
#   warranties, including, but not limited to, the implied warranties of
#   merchantability and fitness for a particular purpose, are disclaimed.
#   In no event shall the authors or the University of Washington be
#   liable for any direct, indirect, incidental, special, exemplary, or
#   consequential damages (including, but not limited to, procurement of
#   substitute goods or services; loss of use, 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.
#
#   Building Consed from source is error prone and not simple which is
#   why I provide executables.  Due to time limitations I cannot
#   provide any assistance in building Consed.  Even if you do not
#   modify the source, you may introduce errors due to using a
#   different version of the compiler, a different version of motif,
#   different versions of other libraries than I used, etc.  For this
#   reason, if you discover Consed bugs, I can only offer help with
#   those bugs if you first reproduce those bugs with an executable
#   provided by me--not an executable you have built.
# 
#   Modifying Consed is also difficult.  Although Consed is modular,
#   some modules are used by many other modules.  Thus making a change
#   in one place can have unforeseen effects on many other features.
#   It may takes months for you to notice these other side-effects
#   which may not seen connected at all.  It is not feasable for me to
#   provide help with modifying Consed sources because of the
#   potentially huge amount of time involved.
#
#*****************************************************************************/
//
// infobutton.h
//
// wrapper around a motif button with client settable label.
// client supplies callback, this pointer (to client) and
// data to identify the button - presumably there are many 
// of these.
//
// because the infobuttons are generally children of forms
// the parent widget will not be available at time of creation.
// hence the ctor does not create the widget.  that must be done
// with the initialize() member function
// chrisa 15-feb-95
//

#ifndef INFOBUTTON_INCLUDED
#define INFOBUTTON_INCLUDED


#ifdef SCCS_ID
static const char* infoButtonSccsId = "@(#)infobutton.h	1.4 09/26/95 02:00:52";
#endif


#include <Xm/Xm.h>
#include <Xm/PushB.h>

#include "rwcstring.h"

#include "assert.h"
#include "sysdepend.h"
#include "motifutils.h"

// func proto for client supplied callbacks
typedef void CbInfoButton(void*, void*);


class InfoButton {
 public:

   // dynamic arrays of these things are likely 
   // e.g. a column of fragment file info buttons
   InfoButton() 
     :
      pCb_(0),
      pvClientThis_(0),
      pvClientData_(0),
      bHasBeenInitialized_(false) {}   

   // must be called before using or managing
   void initialize(Widget,   // parent widget - presumably a form
                   CbInfoButton pCb,     // client callback
                   void* pvClientThis,   // client this
                   void* pvClientData,   // client data
                   const char* szEmpty,  // "empty" label
                   bool bInitiallyVisible,    // initially managed
                   bool bInitiallyActive = true);    // initially active

   void makeVisible() { 
      assert (bHasBeenInitialized_);
      XtManageChild(widButton_); 
   }
   void makeInisible() {
      assert (bHasBeenInitialized_);
      XtUnmanageChild(widButton_); 
   }

   // sets label to passed string
   void setLabel(const char* szLabel) {
      assert (bHasBeenInitialized_);
      setLabelString(widButton_, szLabel);  // from motif utils
   }

   // sets label to "empty" value passed to init
   void emptyLabel() {
      assert (bHasBeenInitialized_);
      setLabelString(widButton_, soEmptyLabel_);  // from motif utils
   }

   // deactivates button (label grey, won't press)
   void deactivate() {
      setSensitive(widButton_, false);
   }
   // activates button  (label clear, can press it)
   void activate() {
      setSensitive(widButton_, true);
   }

   // widget is available to clients
   Widget widGet() { 
      assert (bHasBeenInitialized_);
      return widButton_; 
   }

   // Xt callback for buttonpress.  all buttons hit this,
   // the InfoButton pointer used to redirect to individual's cb
   friend void infoButtonXtCb(Widget,
                              InfoButton*,
                              XmPushButtonCallbackStruct*);

 private:
   Widget widButton_;
   CbInfoButton* pCb_;
   void* pvClientThis_;
   void* pvClientData_;
   bool bHasBeenInitialized_;
   RWCString soEmptyLabel_; // contains "empty" value for label
};

void infoButtonXtCb(Widget,
                    InfoButton*,
                    XmPushButtonCallbackStruct*);




#endif    // INFOBUTTON_INCLUDED