/*****************************************************************************
#   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.
#
#*****************************************************************************/
//
// decisionbox.h
//
// like MessageBox, the DecisionBox is a wrapper
// around a prefab motif dialog box that allows the client
// (programmer) to easily popup a dialog box that gives the
// user a choice to make and two buttons to choose from.
//
// instead of requiring callback procedures, the decisionbox
// blocks, and uses private member data and callbacks to
// pass a decision on to the client, allowing "in-line"
// input from the user
//

#ifndef DECISIONBOX_INCLUDED
#define DECISIONBOX_INCLUDED


#include    <Xm/Xm.h>

#include <iostream.h>
#include <strstream.h>

#include "assert.h"


class DecisionBox : public ostrstream {
 public:
   DecisionBox(const char* szInitialString,
               const char* okButtonLabel = 0,      // default "OK"
               const char* cancelButtonLabel = 0); // default "Cancel"

   ~DecisionBox() {   
      // destroy your (motif) self
      XtDestroyWidget(widDecisionDialog_);
   }

   // pop up the dibox (not automatic).  no text added after this
   // call will be displayed.
   void makeVisible();

   // xt callback needs private member data
   friend void decisionBoxXtCb(Widget widMb, 
                               DecisionBox* pDb,
                               XmPushButtonCallbackStruct* pCbStruct);

   typedef enum 
     { 
        nothingPressedYet,
        okButtonPressed, 
        cancelButtonPressed 
     } WhichButton;

   // allow client to inquire about user response.  comes in two
   // flavors for convenience.  If your code returns from makeVisible(),
   // one of these should be true.
   bool bUserPressedOk() const { 
      assert (whichButton_ != nothingPressedYet);
      return (whichButton_ == okButtonPressed);
   }
   bool bUserPressedCancel() const { 
      assert (whichButton_ != nothingPressedYet);
      return (whichButton_ == cancelButtonPressed); 
   }

 private:
   Widget widDecisionDialog_;

   // this flag is used to block execution of the application code
   // until it gets cleared by the error box button callback
   // used only if blocking requested
   bool bBlockApplication_;

   // this gets set by the xt callback depending on which button
   // user pressed
   WhichButton whichButton_;
};



void decisionBoxXtCb(Widget widMb, 
                               DecisionBox* pDb,
                               XmPushButtonCallbackStruct* pCbStruct);


#endif  // DECISIONBOX_INCLUDED