katerenderer.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 2007 Mirko Stocker <me@misto.ch>
   Copyright (C) 2003-2005 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 <ktexteditor/attribute.h>
#include "katetextline.h"
#include "katelinelayout.h"

#include <QtGui/QFont>
#include <QtGui/QFontMetrics>
#include <QtCore/QList>
#include <QtGui/QTextLine>

class KateDocument;
class KateView;
class KateRendererConfig;
class KateRenderRange;
namespace  KTextEditor { class Range; }

class KateLineLayout;
typedef KSharedPtr<KateLineLayout> KateLineLayoutPtr;

class KateRenderer
{
public:
    enum caretStyles {
      Line,
      Block
    };

    explicit KateRenderer(KateDocument* doc, KateView *view = 0);

    ~KateRenderer();

    KateDocument* doc() const { return m_doc; }

    KateView* view() const { return m_view; }

    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);

    void setCaretOverrideColor(const QColor& color);

    inline bool showTabs() const { return m_showTabs; }

    void setShowTabs(bool showTabs);

    inline bool showTrailingSpaces() const { return m_showSpaces; }

    void setShowTrailingSpaces(bool showSpaces);

    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 QFont& currentFont() const;
    const QFontMetrics& currentFontMetrics() const;

    bool isPrinterFriendly() const;

    void setPrinterFriendly(bool printerFriendly);

    void layoutLine(KateLineLayoutPtr line, int maxwidth = -1, bool cacheLayout = false) const;

    bool isLineRightToLeft( KateLineLayoutPtr lineLayout ) const;

    QList<QTextLayout::FormatRange> decorationsForLine(const Kate::TextLine& textLine, int line, bool selectionsOnly = false, KateRenderRange* completionHighlight = 0L, bool completionSelected = false) const;

    // Width calculators
    uint spaceWidth() const;
#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED uint textWidth(const Kate::TextLine &, int cursorCol);
    KDE_DEPRECATED uint textWidth(const Kate::TextLine &textLine, uint startcol, uint maxwidth, bool *needWrap, int *endX = 0);
    KDE_DEPRECATED uint textWidth(const KTextEditor::Cursor& cursor);
#endif

    int cursorToX(const KateTextLayout& range, int col) const;
    int cursorToX(const KateTextLayout& range, const KTextEditor::Cursor& pos) const;
    int cursorToX(const KateTextLayout& range, const KTextEditor::Cursor& pos, bool returnPastLine) const;

    KTextEditor::Cursor xToCursor(const KateTextLayout& range, int x, bool returnPastLine = false) const;

    // Font height
    uint fontHeight();

    // Line height
    int lineHeight();

    // Document height
    uint documentHeight();

    // Selection boundaries
    bool getSelectionBounds(int line, int lineLength, int &start, int &end) const;

    void paintTextLine(QPainter& paint, KateLineLayoutPtr range, int xStart, int xEnd, const KTextEditor::Cursor* cursor = 0L);

    void paintTextLineBackground(QPainter& paint, KateLineLayoutPtr layout, int currentViewLine, int xStart, int xEnd);

    KTextEditor::Attribute::Ptr attribute(uint pos) const;
    KTextEditor::Attribute::Ptr specificAttribute(int context) const;

  private:
    void paintTrailingSpace(QPainter &paint, qreal x, qreal y);
    void paintTabstop(QPainter &paint, qreal x, qreal y);

    void paintNonBreakSpace(QPainter &paint, qreal x, qreal y);

    void paintIndentMarker(QPainter &paint, uint x, uint y);

    void assignSelectionBrushesFromAttribute(QTextLayout::FormatRange& target, const KTextEditor::Attribute& attribute) const;

    KateDocument *const m_doc;
    KateView *const m_view;

    // cache of config values
    int m_tabWidth;
    int m_indentWidth;

    // some internal flags
    KateRenderer::caretStyles m_caretStyle;
    bool m_drawCaret;
    bool m_showSelections;
    bool m_showTabs;
    bool m_showSpaces;
    bool m_printerFriendly;
    QColor m_caretOverrideColor;

    QList<KTextEditor::Attribute::Ptr> m_attributes;

  public:
    inline KateRendererConfig *config () const { return m_config; }

    void updateConfig ();

  private:
    KateRendererConfig *const m_config;
};

#endif