You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
107 lines
3.8 KiB
107 lines
3.8 KiB
/* This file is part of the KDE project
|
|
Copyright (C) 2002-2003 Laurent Montel <montel@kde.org>
|
|
Copyright (C) 2006 David Faure <faure@kde.org>
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Library General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Library General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Library General Public License
|
|
along with this library; see the file COPYING.LIB. If not, write to
|
|
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef KOTEXTBOOKMARK_H
|
|
#define KOTEXTBOOKMARK_H
|
|
|
|
#include <koffice_export.h>
|
|
#include <tqstring.h>
|
|
#include <tqvaluelist.h>
|
|
#include <tqmap.h>
|
|
class KoTextParag;
|
|
class KoTextDocument;
|
|
|
|
/*
|
|
* A bookmark is a name associated with a single position or a run of text (start and end) in a text document.
|
|
*/
|
|
class KOTEXT_EXPORT KoTextBookmark {
|
|
public:
|
|
KoTextBookmark( const TQString& name = TQString() );
|
|
KoTextBookmark( const TQString& name,
|
|
KoTextParag* startParag, KoTextParag* endParag,
|
|
int start, int end );
|
|
|
|
TQString bookmarkName() const { return m_name; }
|
|
void setBookmarkName( const TQString &name ) { m_name = name; }
|
|
|
|
// Note: the text document always m_startParag->document(), which is also m_endParag->document().
|
|
KoTextDocument* textDocument() const;
|
|
|
|
KoTextParag* startParag() const { return m_startParag; }
|
|
void setStartParag( KoTextParag* parag ) { m_startParag = parag; }
|
|
|
|
KoTextParag* endParag() const { return m_endParag; }
|
|
void setEndParag( KoTextParag* parag ) { m_endParag = parag; }
|
|
|
|
void setBookmarkStartIndex( int pos ) { m_startIndex = pos; }
|
|
int bookmarkStartIndex() const { return m_startIndex; }
|
|
|
|
void setBookmarkEndIndex( int end ) { m_endIndex = end; }
|
|
int bookmarkEndIndex() const { return m_endIndex; }
|
|
|
|
bool isSimple() const { return m_startParag == m_endParag && m_startIndex == m_endIndex; }
|
|
|
|
private:
|
|
TQString m_name;
|
|
KoTextParag* m_startParag;
|
|
KoTextParag* m_endParag;
|
|
int m_startIndex;
|
|
int m_endIndex;
|
|
};
|
|
|
|
class KOTEXT_EXPORT KoTextBookmarkList : public TQValueList<KoTextBookmark>
|
|
{
|
|
public:
|
|
const_iterator findByName( const TQString& name ) const {
|
|
for ( const_iterator it = begin(), itend = end(); it != itend; ++it )
|
|
if ( (*it).bookmarkName() == name )
|
|
return it;
|
|
return end();
|
|
}
|
|
iterator findByName( const TQString& name ) {
|
|
for ( iterator it = begin(), itend = end(); it != itend; ++it )
|
|
if ( (*it).bookmarkName() == name )
|
|
return it;
|
|
return end();
|
|
}
|
|
bool removeByName( const TQString& name ) {
|
|
for ( iterator it = begin(), itend = end(); it != itend; ++it )
|
|
if ( (*it).bookmarkName() == name ) {
|
|
remove( it );
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
/// return a map of bookmarks per paragraph. Note that multi-paragraph bookmarks
|
|
/// will be present twice in the map.
|
|
TQMap<const KoTextParag*, KoTextBookmarkList> bookmarksPerParagraph() const {
|
|
TQMap<const KoTextParag*, KoTextBookmarkList> ret;
|
|
for ( const_iterator it = begin(), itend = end(); it != itend; ++it ) {
|
|
ret[ (*it).startParag() ].append( *it );
|
|
if ( (*it).startParag() != (*it).endParag() )
|
|
ret[ (*it).endParag() ].append( *it );
|
|
}
|
|
return ret;
|
|
}
|
|
};
|
|
|
|
#endif /* KOTEXTBOOKMARK_H */
|
|
|