sequence_viewer_window.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: sequence_viewer_window.hpp,v $
 * PRODUCTION Revision 1000.1  2004/04/12 17:33:44  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.29
 * PRODUCTION
 * ===========================================================================
 */

/*  $Id: sequence_viewer_window.hpp,v 1000.1 2004/04/12 17:33:44 gouriano Exp $
* ===========================================================================
*
*                            PUBLIC DOMAIN NOTICE
*               National Center for Biotechnology Information
*
*  This software/database is a "United States Government Work" under the
*  terms of the United States Copyright Act.  It was written as part of
*  the author's official duties as a United States Government employee and
*  thus cannot be copyrighted.  This software/database is freely available
*  to the public for use. The National Library of Medicine and the U.S.
*  Government have not placed any restriction on its use or reproduction.
*
*  Although all reasonable efforts have been taken to ensure the accuracy
*  and reliability of the software and data, the NLM and the U.S.
*  Government do not and cannot warrant the performance or results that
*  may be obtained by using this software or data. The NLM and the U.S.
*  Government disclaim all warranties, express or implied, including
*  warranties of performance, merchantability or fitness for any particular
*  purpose.
*
*  Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
* Authors:  Paul Thiessen
*
* File Description:
*      implementation of GUI part of main sequence/alignment viewer
*
* ===========================================================================
*/

#ifndef CN3D_SEQUENCE_VIEWER_WINDOW__HPP
#define CN3D_SEQUENCE_VIEWER_WINDOW__HPP

#include "viewer_window_base.hpp"


BEGIN_SCOPE(Cn3D)

class SequenceViewer;
class SequenceDisplay;
class TaxonomyTree;

class SequenceViewerWindow : public ViewerWindowBase
{
    friend class SequenceDisplay;

public:
    SequenceViewerWindow(SequenceViewer *parentSequenceViewer);
    ~SequenceViewerWindow(void);

    bool RequestEditorEnable(bool enable);
    void EnableDerivedEditorMenuItems(bool enabled);
    void TurnOnEditor(void);
    void SetWindowTitle(void);

private:
    SequenceViewer *sequenceViewer;
    TaxonomyTree *taxonomyTree;

    // menu identifiers - additional items beyond base class items
    enum {
        // view menu
        MID_SHOW_HIDE_ROWS = START_VIEWER_WINDOW_DERIVED_MID,
        MID_SCORE_THREADER,
        MID_SELF_HIT,
        MID_TAXONOMY,
            MID_TAXONOMY_FULL,
            MID_TAXONOMY_ABBR,
        MID_EXPORT,
            MID_EXPORT_FASTA,
            MID_EXPORT_A2M,
            MID_EXPORT_TEXT,
            MID_EXPORT_HTML,
        MID_HIGHLIGHT_BLOCKS,
        // edit menu
        MID_DELETE_ROW,
        MID_SORT_ROWS,   // sort rows submenu
            MID_SORT_IDENT,
            MID_SORT_THREADER,
            MID_FLOAT_PDBS,
            MID_FLOAT_HIGHLIGHTS,
            MID_FLOAT_G_V,
            MID_SORT_SELF_HIT,
            MID_PROXIMITY_SORT,
        // mouse mode
        MID_MOVE_ROW,
        // update menu
        MID_SHOW_UPDATES,
        MID_REALIGN_ROW,
        MID_REALIGN_ROWS,
        MID_MARK_BLOCK,
        MID_CLEAR_MARKS
    };

    void OnShowHideRows(wxCommandEvent& event);
    void OnDeleteRow(wxCommandEvent& event);
    void OnMoveRow(wxCommandEvent& event);
    void OnShowUpdates(wxCommandEvent& event);
    void OnRealign(wxCommandEvent& event);
    void OnSort(wxCommandEvent& event);
    void OnScoreThreader(wxCommandEvent& event);
    void OnMarkBlock(wxCommandEvent& event);
    void OnExport(wxCommandEvent& event);
    void OnSelfHit(wxCommandEvent& event);
    void OnTaxonomy(wxCommandEvent& event);
    void OnHighlightBlocks(wxCommandEvent& event);

    // called before an operation (e.g., alignment editor enable) that requires
    // all rows of an alignment to be visible; 'false' return should abort that operation
    bool QueryShowAllRows(void);

    void OnCloseWindow(wxCloseEvent& event);

    wxMenu *updateMenu;

    void DeleteRowOff(void)
    {
        menuBar->Check(MID_DELETE_ROW, false);
        SetCursor(wxNullCursor);
    }
    void RealignRowOff(void)
    {
        menuBar->Check(MID_REALIGN_ROW, false);
        SetCursor(wxNullCursor);
    }
    void MarkBlockOff(void)
    {
        menuBar->Check(MID_MARK_BLOCK, false);
        SetCursor(wxNullCursor);
    }
    void ProximitySortOff(void)
    {
        menuBar->Check(MID_PROXIMITY_SORT, false);
        SetCursor(wxNullCursor);
    }

    SequenceViewerWidget::eMouseMode GetMouseModeForCreateAndMerge(void)
    {
        return SequenceViewerWidget::eSelectColumns;
    }

    DECLARE_EVENT_TABLE()

public:

    bool SaveDialog(bool prompt, bool canCancel);

    bool DoDeleteRow(void) const { return menuBar->IsChecked(MID_DELETE_ROW); }
    bool DoRealignRow(void) const { return menuBar->IsChecked(MID_REALIGN_ROW); }
    bool DoMarkBlock(void) const { return menuBar->IsChecked(MID_MARK_BLOCK); }
    bool DoProximitySort(void) const { return menuBar->IsChecked(MID_PROXIMITY_SORT); }

    void CancelDerivedSpecialModesExcept(int id)
    {
        if (id != MID_DELETE_ROW && DoDeleteRow()) DeleteRowOff();
        if (id != MID_REALIGN_ROW && DoRealignRow()) RealignRowOff();
        if (id != MID_MARK_BLOCK && DoMarkBlock()) MarkBlockOff();
        if (id != MID_PROXIMITY_SORT && DoProximitySort()) ProximitySortOff();
    }

    void EnableExport(bool enabled) { menuBar->Enable(MID_EXPORT, enabled); }
};

END_SCOPE(Cn3D)

#endif // CN3D_SEQUENCE_VIEWER_WINDOW__HPP

/*
* ---------------------------------------------------------------------------
* $Log: sequence_viewer_window.hpp,v $
* Revision 1000.1  2004/04/12 17:33:44  gouriano
* PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.29
*
* Revision 1.29  2004/02/19 17:05:10  thiessen
* remove cn3d/ from include paths; add pragma to disable annoying msvc warning
*
* Revision 1.28  2003/10/20 13:17:15  thiessen
* add float geometry violations sorting
*
* Revision 1.27  2003/08/23 22:42:17  thiessen
* add highlight blocks command
*
* Revision 1.26  2003/02/03 19:20:06  thiessen
* format changes: move CVS Log to bottom of file, remove std:: from .cpp files, and use new diagnostic macros
*
* Revision 1.25  2002/12/06 17:07:15  thiessen
* remove seqrow export format; add choice of repeat handling for FASTA export; export rows in display order
*
* Revision 1.24  2002/12/02 13:37:09  thiessen
* add seqrow format export
*
* Revision 1.23  2002/10/07 18:51:53  thiessen
* add abbreviated taxonomy tree
*
* Revision 1.22  2002/09/09 22:51:19  thiessen
* add basic taxonomy tree viewer
*
* Revision 1.21  2002/09/09 13:38:23  thiessen
* separate save and save-as
*
* Revision 1.20  2002/09/05 18:38:58  thiessen
* add sort by highlights
*
* Revision 1.19  2002/09/03 13:15:58  thiessen
* add A2M export
*
* Revision 1.18  2002/06/13 14:54:07  thiessen
* add sort by self-hit
*
* Revision 1.17  2002/06/13 13:32:39  thiessen
* add self-hit calculation
*
* Revision 1.16  2002/06/05 14:28:40  thiessen
* reorganize handling of window titles
*
* Revision 1.15  2002/05/17 19:10:27  thiessen
* preliminary range restriction for BLAST/PSSM
*
* Revision 1.14  2002/04/22 14:27:29  thiessen
* add alignment export
*
* Revision 1.13  2001/12/06 23:13:46  thiessen
* finish import/align new sequences into single-structure data; many small tweaks
*
* Revision 1.12  2001/06/04 14:33:55  thiessen
* add proximity sort; highlight sequence on browser launch
*
* Revision 1.11  2001/06/01 14:04:54  thiessen
* add float PDB sort
*
* Revision 1.10  2001/05/23 17:43:28  thiessen
* change dialog implementation to wxDesigner; interface changes
*
* Revision 1.9  2001/05/11 02:10:04  thiessen
* add better merge fail indicators; tweaks to windowing/taskbar
*
* Revision 1.8  2001/05/09 17:14:52  thiessen
* add automatic block removal upon demotion
*
* Revision 1.7  2001/04/05 22:54:51  thiessen
* change bg color handling ; show geometry violations
*
* Revision 1.6  2001/03/30 14:43:11  thiessen
* show threader scores in status line; misc UI tweaks
*
* Revision 1.5  2001/03/30 03:07:09  thiessen
* add threader score calculation & sorting
*
* Revision 1.4  2001/03/19 15:47:38  thiessen
* add row sorting by identifier
*
* Revision 1.3  2001/03/13 01:24:16  thiessen
* working undo system for >1 alignment (e.g., update window)
*
* Revision 1.2  2001/03/09 15:48:43  thiessen
* major changes to add initial update viewer
*
* Revision 1.1  2001/03/01 20:15:29  thiessen
* major rearrangement of sequence viewer code into base and derived classes
*
*/