English
- /*
- * ===========================================================================
- * PRODUCTION $Log: comment.hpp,v $
- * PRODUCTION Revision 1000.0 2004/06/01 19:54:36 gouriano
- * PRODUCTION PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.4
- * PRODUCTION
- * ===========================================================================
- */
- #ifndef GUI_OBJUTILS___COMMENT__HPP
- #define GUI_OBJUTILS___COMMENT__HPP
- /* $Id: comment.hpp,v 1000.0 2004/06/01 19:54:36 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: Vlad Lebedev
- *
- * File Description:
- * CLayoutComment -- utility class for having comments in graphical layouts.
- */
- #include <corelib/ncbiobj.hpp>
- #include <gui/objutils/layout.hpp>
- #include <objects/seqloc/Seq_interval.hpp>
- /** @addtogroup GUI_OBJUTILS
- *
- * @{
- */
- BEGIN_NCBI_SCOPE
- class NCBI_GUIOBJUTILS_EXPORT CLayoutComment : public CLayoutObject
- {
- public:
- // ctors
- CLayoutComment(string comment);
- //
- // pure virtual requirements
- //
- // Access the feature's remapped location
- const string& GetComment(void) const;
- // access the position of this object.
- const objects::CSeq_loc& GetLocation(void) const;
- // access our core component - we wrap an object of some sort
- const CObject* GetObject(TSeqPos pos) const;
- bool HasObject(const CObject* obj) const;
- // Comparators
- bool LessByPos (const CLayoutObject& obj) const;
- bool LessBySize(const CLayoutObject& obj) const;
- // retrieve the type of this object
- EType GetType() const;
- // Is this layout object selectable in the viewers?
- bool IsSelectable() const;
- protected:
- // Location is not real.
- // Comments will occuy an entire row in layout
- CRef<objects::CSeq_loc> m_Location;
- string m_Comment;
- };
- inline
- bool CLayoutComment::IsSelectable() const
- {
- return false;
- }
- inline
- const string& CLayoutComment::GetComment(void) const
- {
- return m_Comment;
- }
- inline
- const objects::CSeq_loc& CLayoutComment::GetLocation(void) const
- {
- return *m_Location;
- }
- inline
- const CObject* CLayoutComment::GetObject(TSeqPos pos) const
- {
- return NULL;
- }
- inline
- bool CLayoutComment::HasObject(const CObject*) const
- {
- return false;
- }
- inline
- bool CLayoutComment::LessByPos(const CLayoutObject& obj) const
- {
- return false;
- }
- inline
- bool CLayoutComment::LessBySize(const CLayoutObject& obj) const
- {
- return false;
- }
- inline
- CLayoutComment::EType CLayoutComment::GetType() const
- {
- return eComment;
- }
- END_NCBI_SCOPE
- /* @} */
- /*
- * ===========================================================================
- * $Log: comment.hpp,v $
- * Revision 1000.0 2004/06/01 19:54:36 gouriano
- * PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.4
- *
- * Revision 1.4 2004/05/14 14:24:47 dicuccio
- * Added new pure virtual requirement on CLayoutObject(): GetType(), returns enum
- * defined in CLayoutObject
- *
- * Revision 1.3 2004/05/03 13:34:54 dicuccio
- * FIxed include guards, doxygen groups
- *
- * Revision 1.2 2004/05/03 12:41:35 dicuccio
- * Fixed #includes and export specifiers
- *
- * Revision 1.1 2004/04/30 11:52:52 dicuccio
- * Split out from gui/utils
- *
- * Revision 1.3 2004/04/16 14:27:17 dicuccio
- * Added doxygen module tag
- *
- * Revision 1.2 2004/04/15 12:57:43 lebedev
- * Changed GetObject to return NULL or const pointer based on given position
- *
- * Revision 1.1 2004/02/24 14:36:54 lebedev
- * Initial revision
- *
- * ===========================================================================
- */
- #endif // GUI_OBJUTILS___COMMENT__HPP
