include/gui/utils/command.hpp

Go to the documentation of this file.

#ifndef GUI_UTILS___COMMAND__HPP
#define GUI_UTILS___COMMAND__HPP

/*  $Id: command.hpp 18080 2008-10-14 22:33:27Z yazhuk $
 * ===========================================================================
 *
 *                            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:  Andrey Yazhuk
 *
 */

/** @addtogroup GUI_UTILS
*
* @{
*/

/// @file command.hpp
/// GUI command routing and handling framework.
///
/// The following are parts of the framework:
/// CCommandTarget class - represents a class capable of handling commands
/// using command maps.
/// Command map - structure mapping command IDs to handler funtion pointers.
/// IMenu - interface for CCommandTraget compatible menus.

#include <corelib/ncbistl.hpp>
#include <corelib/ncbistd.hpp>

#include <gui/gui.hpp>

#include <gui/utils/event_handler.hpp>


BEGIN_NCBI_SCOPE

////////////////////////////////////////////////////////////////////////////////
/// ICmdUI - interface for updating command GUI elements such as menu itms and
/// tool bar buttons.
class ICmdUI : public IEventAttachment
{
public:
    virtual ~ICmdUI()    {}

    virtual TCmdID  GetCommand() const = 0;
    virtual void    Enable(bool en) = 0;
    virtual void    SetCheck(bool set) = 0;
    virtual void    SetRadio(bool set) = 0;
    virtual void    SetLabel(const string& label) = 0;
};


/// callback for updating command UI elements
typedef     void (CEventHandler::*FCMDUpdateHandler) (ICmdUI*);


/// Definitions for generic commands.
///
/// Subsytems of GUI should define they own command enumerations, preferable
/// with non-overlapping ranges.

enum EBaseCommands   {
    eCmdMenuEnd = -2, /// marks menu end in array initializers
    eCmdInvalid = -1, /// not a valid command
    eCmdNone = 0, /// empty command

    /// zoom events
    eCmdZoomIn,
    eCmdZoomOut,
    eCmdZoomAll,
    eCmdZoomInMouse,
    eCmdZoomOutMouse,
    eCmdZoomSel, /// Zoom to Selection
    eCmdZoomSeq, /// Zoom to Sequence
    eCmdZoomObjects,
    eCmdZoomSelObjects,
    eCmdZoomInX,
    eCmdZoomOutX,
    eCmdZoomAllX,
    eCmdZoomInY,
    eCmdZoomOutY,
    eCmdZoomAllY,
    eCmdSetEqualScale,

    eCmdSettings, // widget/view settings

    eCmdResetSelection,

    eCmdEditSelection,
    eCmdDeleteSelection,
    eCmdDeleteSelectionAndOrphaned,

    /// Navigation commands
    eCmdBack,
    eCmdForward,

    /// goto sequence position
    eCmdSeqGoto,

    // insert new command here
    eBaseCmdLast
};


END_NCBI_SCOPE

/* @} */

#endif  // GUI_UTILS___COMMAND__HPP

---