// -*- C++ -*-
/* This file is part of
 * ====================================================== 
 * 
 *           LyX, The Document Processor
 * 	 
 *           Copyright 1995 Matthias Ettrich
 *           Copyright 1995-2001 The LyX Team
 *
 * ====================================================== */

#ifndef LYXSCREEN_H
#define LYXSCREEN_H

#ifdef __GNUG__
#pragma interface
#endif

#include FORMS_H_LOCATION
#include <X11/Xlib.h>

class LyXText;
class WorkArea;
class Buffer;
class BufferView;

struct Row;

///
typedef unsigned short Dimension;


/** The class LyXScreen is used for the main Textbody.
    Concretely, the screen is held in a pixmap.  This pixmap is kept up to
    date and used to optimize drawing on the screen.
    This class also handles the drawing of the cursor and partly the selection.
 */
class LyXScreen {
public:
	///
	enum Cursor_Shape {
		///
		BAR_SHAPE,
		///
		L_SHAPE,
		///
		REVERSED_L_SHAPE
	};

	///
	LyXScreen(WorkArea &);

	/// Sets the cursor color to LColor::cursor.
	void setCursorColor();
	
	/** Draws the screen form textposition y. Uses as much of
	    the already printed pixmap as possible */
	void Draw(LyXText *, BufferView *, unsigned int y);

	/// Redraws the screen, without using existing pixmap
	void Redraw(LyXText *, BufferView *);
   
	/// Returns a new top so that the cursor is visible
	unsigned int TopCursorVisible(LyXText const *);
	/// Redraws the screen such that the cursor is visible
	bool FitCursor(LyXText *, BufferView *);
	///
	void ShowCursor(LyXText const *, BufferView const *);
	///
	void HideCursor();
	///
	void CursorToggle(LyXText const *, BufferView const *);
	///
	void ShowManualCursor(LyXText const *, int x, int y,
			      int asc, int desc,
			      Cursor_Shape shape);
	/// returns 1 if first has changed, otherwise 0
	bool FitManualCursor(LyXText *, BufferView *, int, int, int, int);
	///
	void ToggleSelection(LyXText *, BufferView *, bool = true,
			     int y_offset = 0, int x_offset = 0);
	///
	void ToggleToggle(LyXText *, BufferView *,
			  int y_offset = 0, int x_offset = 0);
	
	/** Updates part of the screen. If text->status is
	    LyXText::NEED_MORE_REFRESH, we update from the
	    point of change and to the end of the screen.
	    If text->status is LyXText::NEED_VERY_LITTLE_REFRESH,
	    we only update the current row. */
	void Update(LyXText *, BufferView *, int y_offset=0, int x_offset=0);
	///
	bool forceClear() const { return force_clear; }

	///
	bool cursor_visible;
private:
	/// Copies specified area of pixmap to screen
	void expose(int x, int y, int exp_width, int exp_height); 

	/// y1 and y2 are coordinates of the screen
	void DrawFromTo(LyXText *, BufferView *, int y1, int y2,
			int y_offset = 0, int x_offset = 0);

	/// y is a coordinate of the text
	void DrawOneRow(LyXText *, BufferView *, Row * row,
			int y_text, int y_offset = 0, int x_offset = 0);

	///
	WorkArea & owner;
	
	///
	Pixmap cursor_pixmap;
	///
	int cursor_pixmap_x;
	///
	int cursor_pixmap_y;
	///
	int cursor_pixmap_w;
	///
	int cursor_pixmap_h;
	///
	GC gc_copy;
	///
	bool force_clear;
};

#endif