ScreenWindow.h

Go to the documentation of this file.

/*
    Copyright 2007-2008 by Robert Knight <robertknight@gmail.com>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301  USA.
*/

#ifndef SCREENWINDOW_H
#define SCREENWINDOW_H

// Qt
#include <QtCore/QObject>
#include <QtCore/QPoint>
#include <QtCore/QRect>

// Konsole
#include "Character.h"

namespace Konsole
{
class Screen;

class ScreenWindow : public QObject
{
    Q_OBJECT

public:
    explicit ScreenWindow(Screen* screen, QObject* parent = 0);
    virtual ~ScreenWindow();

    void setScreen(Screen* screen);
    Screen* screen() const;

    Character* getImage();

    QVector<LineProperty> getLineProperties();

    int scrollCount() const;

    void resetScrollCount();

    QRect scrollRegion() const;


    void setCurrentResultLine(int line);
    int currentResultLine() const;

    void setSelectionStart(int column , int line , bool columnMode);
    void setSelectionEnd(int column , int line);

    void setSelectionByLineRange(int start, int end);

    void getSelectionStart(int& column , int& line);
    void getSelectionEnd(int& column , int& line);
    bool isSelected(int column , int line);
    void clearSelection();

    void setWindowLines(int lines);
    int windowLines() const;
    int windowColumns() const;

    int lineCount() const;
    int columnCount() const;

    int currentLine() const;

    QPoint cursorPosition() const;

    bool atEndOfOutput() const;

    void scrollTo(int line);

    enum RelativeScrollMode {
        ScrollLines,
        ScrollPages
    };

    void scrollBy(RelativeScrollMode mode, int amount, bool fullPage);

    void setTrackOutput(bool trackOutput);
    bool trackOutput() const;

    QString selectedText(bool preserveLineBreaks, bool trimTrailingSpaces = false) const;

public slots:
    void notifyOutputChanged();

signals:
    void outputChanged();

    void currentResultLineChanged();

    void scrolled(int line);

    void selectionChanged();

private:
    int endWindowLine() const;
    void fillUnusedArea();

    Screen* _screen; // see setScreen() , screen()
    Character* _windowBuffer;
    int _windowBufferSize;
    bool _bufferNeedsUpdate;

    int  _windowLines;
    int  _currentLine; // see scrollTo() , currentLine()
    int _currentResultLine;
    bool _trackOutput; // see setTrackOutput() , trackOutput()
    int  _scrollCount; // count of lines which the window has been scrolled by since
    // the last call to resetScrollCount()
};
}
#endif // SCREENWINDOW_H