KoTextCustomItem.h

/* This file is part of the KDE project
 
   Original TQTextCustomItem is
     Copyright (C) 1999-2000 Trolltech AS.  All rights reserved.
   KoText modifications
     Copyright (C) 2001-2005 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.
*/
 
// This file isn't standalone at this point; it's included by KoRichText.h

class KOTEXT_EXPORT KoTextCustomItem
{
public:
    KoTextCustomItem( KoTextDocument *p );
    virtual ~KoTextCustomItem();
    virtual void draw(TQPainter* p, int x, int y, int cx, int cy, int cw, int ch, const TQColorGroup& cg, bool selected ) /* = 0*/;
 
    // Called after the item's paragraph has been formatted
    virtual void finalize() {}
 
    void move( int x, int y ) { xpos = x; ypos = y; }
    int x() const { return xpos; }
    int y() const { return ypos; }
 
    // Called when the format of the character is being changed, see KoTextStringChar::setFormat
    virtual void setFormat( KoTextFormat * ) { }
 
    //virtual void setPainter( TQPainter*, bool adjust );
 
    enum Placement { PlaceInline = 0, PlaceLeft, PlaceRight };
    virtual Placement placement() const { return PlaceInline; }
    bool placeInline() { return placement() == PlaceInline; }
 
    virtual bool ownLine() const { return false; }
    // Called for "ownline" items
    virtual void resize( int nwidth ) { width = nwidth; }
    virtual void invalidate() {};
 
    virtual bool isNested() const { return false; }
    virtual int minimumWidth() const { return 0; }
    virtual int widthHint() const { return 0; }
    virtual int ascent() const { return height; }
 
    virtual TQString richText() const { return TQString(); }
 
    int width;
    int height;
 
    TQRect geometry() const { return TQRect( xpos, ypos, width, height ); }
 
    virtual bool enter( KoTextCursor *, KoTextDocument *&doc, KoTextParag *&parag, int &idx, int &ox, int &oy, bool atEnd = false );
    virtual bool enterAt( KoTextCursor *, KoTextDocument *&doc, KoTextParag *&parag, int &idx, int &ox, int &oy, const TQPoint & );
    virtual bool next( KoTextCursor *, KoTextDocument *&doc, KoTextParag *&parag, int &idx, int &ox, int &oy );
    virtual bool prev( KoTextCursor *, KoTextDocument *&doc, KoTextParag *&parag, int &idx, int &ox, int &oy );
    virtual bool down( KoTextCursor *, KoTextDocument *&doc, KoTextParag *&parag, int &idx, int &ox, int &oy );
    virtual bool up( KoTextCursor *, KoTextDocument *&doc, KoTextParag *&parag, int &idx, int &ox, int &oy );
 
    void setParagraph( KoTextParag * p ) { parag = p; }
    KoTextParag *paragraph() const { return parag; }
 
    virtual void pageBreak( int /*y*/, KoTextFlow* /*flow*/ ) {}
 
    KoTextDocument *parent;
 
 

    KoTextDocument * textDocument() const { return parent; }

    virtual void setDeleted( bool b ) { m_deleted = b; }
 
    bool isDeleted() const { return m_deleted; }

    virtual KCommand * createCommand() { return 0L; }
    virtual KCommand * deleteCommand() { return 0L; }

    virtual void save( TQDomElement& formatElem ) = 0;
    virtual void saveOasis( KoXmlWriter& writer, KoSavingContext& context ) const = 0;
    virtual int typeId() const = 0;

    virtual void resize() {}

    virtual void recalc() { resize(); }

    int index() const;

    KoTextFormat * format() const;

    virtual void drawCustomItem(TQPainter* p, int x, int y, int wpix, int hpix, int ascentpix, int cx, int cy, int cw, int ch, const TQColorGroup& cg, bool selected, int offset,  bool drawingShadow) = 0;
 
protected:
    bool m_deleted;
 
protected:
    int xpos;
    int ypos;
private:
    KoTextParag *parag;
};