/*****************************************************************************
#   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.
#
#*****************************************************************************/
#ifndef GUIMULTICONTIGNAVIGATOR_INCLUDED
#define GUIMULTICONTIGNAVIGATOR_INCLUDED


#include    <Xm/Xm.h>

#include    "guiapp.h"
#include    "gotoList.h"
#include    "motifutils.h"
#include    "soEmptyString.h"
#include    "rwcstring.h"



// forward declaration to allow ctor to accept ptr argument
class ContigWin;
class assemblyView;

// value returned when nothing is selected
static const int navigatorNoSelection = -1;


typedef void cbSpecialPurposeButton( const gotoItem* pGotoItem,
                                     void* pClientData );
    // pClientData is the same regardless which item is selected


class guiMultiContigNavigator {
 public:
   guiMultiContigNavigator( const RWCString& soWindowTitle,
                            const RWCString& soTextForFirstLine,
                            const RWCString& soTextForSecondLine = soEmptyString,
                            const int nWidthInChars = 75,
                            const RWCString& soTitleOfSpecialPurposeButton 
                                 = soEmptyString,
                            cbSpecialPurposeButton cbS = NULL,
                            void* pClientDataForCbSpecialPurposeButton = NULL,
                            Widget widTopLevelShellToBeConnectedTo = NULL,
                            gotoList* pGotoList = NULL,
                            ContigWin* pContigWin = NULL,
                            const RWCString& soTextForThirdLine = soEmptyString );

   ~guiMultiContigNavigator();

   // needed by RWTPtrOrderedVector
   bool operator==( const guiMultiContigNavigator& guiMulti2 ) const {
      return( this == &guiMulti2 );
   }

   // raw xt callbacks need private member functions
   friend void guiMultiContigNavigatorXtButtonCb(Widget,
                                   XtPointer,
                                   XmSelectionBoxCallbackStruct*);

   void saveNavigatorList();
   void saveNavigatorList2( const RWCString& soFilename );

   void appendToMultiContigNavigator( gotoItem* pGotoItemToAppend );
   void guiMultiContigNavigatorXtButtonCb2( Widget wid );

   void appendToList( gotoItem* pGotoItemToAppend );

   void displayList( const bool bSortByStartPosition );
   
   void popDownAndDestroy();

   void gotoNextOrPreviousItem( const bool bNextNotPrevious );

   void raiseWindow();

   void scrollDownToBottom();

 public:
   gotoList* pGotoList_;

   Widget widPopupShell_;
   Widget widFirstLineText_;
   Widget widSecondLineText_;
   Widget widSelectionBox_;
   Widget widList_;
   Widget widGoButton_;
   Widget widPrevButton_;
   Widget widNextButton_;
   Widget widSaveButton_;
   Widget widSpecialPurposeButton_;
   Widget widDismissButton_;

   cbSpecialPurposeButton* pcbSpecialPurposeButton_;
   void* pClientDataForSpecialPurposeButton_;

   int nCurrentSelection_; // which item in list is currently selected

   ContigWin* pContigWin_;
   // the contigwin which was used to call this.  If this is called
   // from something other than a contigwin (such as the custom navigation),
   // then this is null
   assemblyView* pAssemblyView_;
   // if guiMultiContigNavigator is called from assemblyView, then
   // this is filled in.  NULL otherwise.


 private:
   int nGetMaxIndex() const { return pGotoList_->nGetNumGotoItems(); }

   // passed the xm string returned from the selection callback,
   // returns the integer index into the gotoList
   int nGetGotoItemIndexFromXmString(XmString xms);

   // passed the index into the gotoList, returns the corresponding
   // XmString from the selection box
   XmString xmsGetXmStringFromGotoItemIndex(const int);

   void setSelectionValue(XmString xms);

   void unmanage() { XtPopdown( widPopupShell_ ); }
};


void guiMultiContigNavigatorXtButtonCb(Widget,
                                   XtPointer,
                                   XmSelectionBoxCallbackStruct*);




#endif