katerenderer.h

/* This file is part of the KDE libraries
   Copyright (C) 2003 Hamish Rodda <rodda@kde.org>
   Copyright (C) 2001 Christoph Cullmann <cullmann@kde.org>
   Copyright (C) 2001 Joseph Wenninger <jowenn@kde.org>
   Copyright (C) 1999 Jochen Wilhelmy <digisnap@cs.tu-berlin.de>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.
 
   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 __KATE_RENDERER_H__
#define __KATE_RENDERER_H__
 
#include "katecursor.h"
#include "kateattribute.h"
#include "katetextline.h"
 
#include <tqfont.h>
#include <tqfontmetrics.h>
 
class KateDocument;
class KateView;
class KateLineRange;
class KateRendererConfig;
 
class KateRenderer
{
public:
    enum caretStyles {
      Insert,
      Replace
    };
 
    KateRenderer(KateDocument* doc, KateView *view = 0);
 
    ~KateRenderer();
 
    void updateAttributes ();
 
    inline bool drawCaret() const { return m_drawCaret; }
 
    void setDrawCaret(bool drawCaret);
 
    inline KateRenderer::caretStyles caretStyle() const { return m_caretStyle; }
 
    void setCaretStyle(KateRenderer::caretStyles style);
 
    inline bool showTabs() const { return m_showTabs; }
 
    void setShowTabs(bool showTabs);
 
    void setTabWidth(int tabWidth);
 
    bool showIndentLines() const;
 
    void setShowIndentLines(bool showLines);
    
    void setIndentWidth(int indentWidth);
    
    inline bool showSelections() const { return m_showSelections; }
 
    void setShowSelections(bool showSelections);
 
    void increaseFontSizes();
    void decreaseFontSizes();
    const TQFont* currentFont();
    const TQFontMetrics* currentFontMetrics();
 
    bool isPrinterFriendly() const;
 
    void setPrinterFriendly(bool printerFriendly);
 
    // Width calculators
    uint spaceWidth();
    uint textWidth(const KateTextLine::Ptr &, int cursorCol);
    uint textWidth(const KateTextLine::Ptr &textLine, uint startcol, uint maxwidth, bool *needWrap, int *endX = 0);
    uint textWidth(const KateTextCursor &cursor);
 
    // Cursor constrainer
    uint textWidth(KateTextCursor &cursor, int xPos, uint startCol = 0);
 
    // Column calculators
    uint textPos(uint line, int xPos, uint startCol = 0, bool nearest=true);
    uint textPos(const KateTextLine::Ptr &, int xPos, uint startCol = 0, bool nearest=true);
 
    // Font height
    uint fontHeight();
 
    // Document height
    uint documentHeight();
 
    // Selection boundaries
    bool getSelectionBounds(uint line, uint lineLength, uint &start, uint &end);
 
    void paintTextLine(TQPainter& paint, const KateLineRange* range, int xStart, int xEnd, const KateTextCursor* cursor = 0L, const KateBracketRange* bracketmark = 0L);
 
    bool paintTextLineBackground(TQPainter& paint, int line, bool isCurrentLine, int xStart, int xEnd);
 
    KateAttribute* attribute(uint pos);
 
  private:
    void paintWhitespaceMarker(TQPainter &paint, uint x, uint y);
 
    void paintIndentMarker(TQPainter &paint, uint x, uint y);
 
    KateDocument* m_doc;
    KateView *m_view;
 
    // cache of config values
    int m_tabWidth;
    int m_indentWidth;
    uint m_schema;
 
    // some internal flags
    KateRenderer::caretStyles m_caretStyle;
    bool m_drawCaret;
    bool m_showSelections;
    bool m_showTabs;
    bool m_printerFriendly;
 
    TQMemArray<KateAttribute> *m_attributes;
 
  public:
    inline KateRendererConfig *config () { return m_config; };
 
    void updateConfig ();
 
  private:
    KateRendererConfig *m_config;
};
 
#endif