+++ /dev/null
-/*
- * Jexer - Java Text User Interface
- *
- * The MIT License (MIT)
- *
- * Copyright (C) 2019 Kevin Lamonte
- *
- * Permission is hereby granted, free of charge, to any person obtaining a
- * copy of this software and associated documentation files (the "Software"),
- * to deal in the Software without restriction, including without limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the
- * Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
- * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
- * DEALINGS IN THE SOFTWARE.
- *
- * @author Kevin Lamonte [kevin.lamonte@gmail.com]
- * @version 1
- */
-package jexer.backend;
-
-import jexer.bits.Cell;
-import jexer.bits.CellAttributes;
-
-/**
- * Drawing operations API.
- */
-public interface Screen {
-
- /**
- * Set drawing offset for x.
- *
- * @param offsetX new drawing offset
- */
- public void setOffsetX(final int offsetX);
-
- /**
- * Set drawing offset for y.
- *
- * @param offsetY new drawing offset
- */
- public void setOffsetY(final int offsetY);
-
- /**
- * Get right drawing clipping boundary.
- *
- * @return drawing boundary
- */
- public int getClipRight();
-
- /**
- * Set right drawing clipping boundary.
- *
- * @param clipRight new boundary
- */
- public void setClipRight(final int clipRight);
-
- /**
- * Get bottom drawing clipping boundary.
- *
- * @return drawing boundary
- */
- public int getClipBottom();
-
- /**
- * Set bottom drawing clipping boundary.
- *
- * @param clipBottom new boundary
- */
- public void setClipBottom(final int clipBottom);
-
- /**
- * Get left drawing clipping boundary.
- *
- * @return drawing boundary
- */
- public int getClipLeft();
-
- /**
- * Set left drawing clipping boundary.
- *
- * @param clipLeft new boundary
- */
- public void setClipLeft(final int clipLeft);
-
- /**
- * Get top drawing clipping boundary.
- *
- * @return drawing boundary
- */
- public int getClipTop();
-
- /**
- * Set top drawing clipping boundary.
- *
- * @param clipTop new boundary
- */
- public void setClipTop(final int clipTop);
-
- /**
- * Get dirty flag.
- *
- * @return if true, the logical screen is not in sync with the physical
- * screen
- */
- public boolean isDirty();
-
- /**
- * Get the attributes at one location.
- *
- * @param x column coordinate. 0 is the left-most column.
- * @param y row coordinate. 0 is the top-most row.
- * @return attributes at (x, y)
- */
- public CellAttributes getAttrXY(final int x, final int y);
-
- /**
- * Get the cell at one location.
- *
- * @param x column coordinate. 0 is the left-most column.
- * @param y row coordinate. 0 is the top-most row.
- * @return the character + attributes
- */
- public Cell getCharXY(final int x, final int y);
-
- /**
- * Set the attributes at one location.
- *
- * @param x column coordinate. 0 is the left-most column.
- * @param y row coordinate. 0 is the top-most row.
- * @param attr attributes to use (bold, foreColor, backColor)
- */
- public void putAttrXY(final int x, final int y,
- final CellAttributes attr);
-
- /**
- * Set the attributes at one location.
- *
- * @param x column coordinate. 0 is the left-most column.
- * @param y row coordinate. 0 is the top-most row.
- * @param attr attributes to use (bold, foreColor, backColor)
- * @param clip if true, honor clipping/offset
- */
- public void putAttrXY(final int x, final int y,
- final CellAttributes attr, final boolean clip);
-
- /**
- * Fill the entire screen with one character with attributes.
- *
- * @param ch character to draw
- * @param attr attributes to use (bold, foreColor, backColor)
- */
- public void putAll(final int ch, final CellAttributes attr);
-
- /**
- * Render one character with attributes.
- *
- * @param x column coordinate. 0 is the left-most column.
- * @param y row coordinate. 0 is the top-most row.
- * @param ch character + attributes to draw
- */
- public void putCharXY(final int x, final int y, final Cell ch);
-
- /**
- * Render one character with attributes.
- *
- * @param x column coordinate. 0 is the left-most column.
- * @param y row coordinate. 0 is the top-most row.
- * @param ch character to draw
- * @param attr attributes to use (bold, foreColor, backColor)
- */
- public void putCharXY(final int x, final int y, final int ch,
- final CellAttributes attr);
-
- /**
- * Render one character without changing the underlying attributes.
- *
- * @param x column coordinate. 0 is the left-most column.
- * @param y row coordinate. 0 is the top-most row.
- * @param ch character to draw
- */
- public void putCharXY(final int x, final int y, final int ch);
-
- /**
- * Render a string. Does not wrap if the string exceeds the line.
- *
- * @param x column coordinate. 0 is the left-most column.
- * @param y row coordinate. 0 is the top-most row.
- * @param str string to draw
- * @param attr attributes to use (bold, foreColor, backColor)
- */
- public void putStringXY(final int x, final int y, final String str,
- final CellAttributes attr);
-
- /**
- * Render a string without changing the underlying attribute. Does not
- * wrap if the string exceeds the line.
- *
- * @param x column coordinate. 0 is the left-most column.
- * @param y row coordinate. 0 is the top-most row.
- * @param str string to draw
- */
- public void putStringXY(final int x, final int y, final String str);
-
- /**
- * Draw a vertical line from (x, y) to (x, y + n).
- *
- * @param x column coordinate. 0 is the left-most column.
- * @param y row coordinate. 0 is the top-most row.
- * @param n number of characters to draw
- * @param ch character to draw
- * @param attr attributes to use (bold, foreColor, backColor)
- */
- public void vLineXY(final int x, final int y, final int n,
- final int ch, final CellAttributes attr);
-
- /**
- * Draw a horizontal line from (x, y) to (x + n, y).
- *
- * @param x column coordinate. 0 is the left-most column.
- * @param y row coordinate. 0 is the top-most row.
- * @param n number of characters to draw
- * @param ch character to draw
- * @param attr attributes to use (bold, foreColor, backColor)
- */
- public void hLineXY(final int x, final int y, final int n,
- final int ch, final CellAttributes attr);
-
- /**
- * Change the width. Everything on-screen will be destroyed and must be
- * redrawn.
- *
- * @param width new screen width
- */
- public void setWidth(final int width);
-
- /**
- * Change the height. Everything on-screen will be destroyed and must be
- * redrawn.
- *
- * @param height new screen height
- */
- public void setHeight(final int height);
-
- /**
- * Change the width and height. Everything on-screen will be destroyed
- * and must be redrawn.
- *
- * @param width new screen width
- * @param height new screen height
- */
- public void setDimensions(final int width, final int height);
-
- /**
- * Get the height.
- *
- * @return current screen height
- */
- public int getHeight();
-
- /**
- * Get the width.
- *
- * @return current screen width
- */
- public int getWidth();
-
- /**
- * Reset screen to not-bold, white-on-black. Also flushes the offset and
- * clip variables.
- */
- public void reset();
-
- /**
- * Flush the offset and clip variables.
- */
- public void resetClipping();
-
- /**
- * Clear the logical screen.
- */
- public void clear();
-
- /**
- * Draw a box with a border and empty background.
- *
- * @param left left column of box. 0 is the left-most row.
- * @param top top row of the box. 0 is the top-most row.
- * @param right right column of box
- * @param bottom bottom row of the box
- * @param border attributes to use for the border
- * @param background attributes to use for the background
- */
- public void drawBox(final int left, final int top,
- final int right, final int bottom,
- final CellAttributes border, final CellAttributes background);
-
- /**
- * Draw a box with a border and empty background.
- *
- * @param left left column of box. 0 is the left-most row.
- * @param top top row of the box. 0 is the top-most row.
- * @param right right column of box
- * @param bottom bottom row of the box
- * @param border attributes to use for the border
- * @param background attributes to use for the background
- * @param borderType if 1, draw a single-line border; if 2, draw a
- * double-line border; if 3, draw double-line top/bottom edges and
- * single-line left/right edges (like Qmodem)
- * @param shadow if true, draw a "shadow" on the box
- */
- public void drawBox(final int left, final int top,
- final int right, final int bottom,
- final CellAttributes border, final CellAttributes background,
- final int borderType, final boolean shadow);
-
- /**
- * Draw a box shadow.
- *
- * @param left left column of box. 0 is the left-most row.
- * @param top top row of the box. 0 is the top-most row.
- * @param right right column of box
- * @param bottom bottom row of the box
- */
- public void drawBoxShadow(final int left, final int top,
- final int right, final int bottom);
-
- /**
- * Clear the physical screen.
- */
- public void clearPhysical();
-
- /**
- * Unset every image cell on one row of the physical screen, forcing
- * images on that row to be redrawn.
- *
- * @param y row coordinate. 0 is the top-most row.
- */
- public void unsetImageRow(final int y);
-
- /**
- * Classes must provide an implementation to push the logical screen to
- * the physical device.
- */
- public void flushPhysical();
-
- /**
- * Put the cursor at (x,y).
- *
- * @param visible if true, the cursor should be visible
- * @param x column coordinate to put the cursor on
- * @param y row coordinate to put the cursor on
- */
- public void putCursor(final boolean visible, final int x, final int y);
-
- /**
- * Hide the cursor.
- */
- public void hideCursor();
-
- /**
- * Get the cursor visibility.
- *
- * @return true if the cursor is visible
- */
- public boolean isCursorVisible();
-
- /**
- * Get the cursor X position.
- *
- * @return the cursor x column position
- */
- public int getCursorX();
-
- /**
- * Get the cursor Y position.
- *
- * @return the cursor y row position
- */
- public int getCursorY();
-
- /**
- * Set the window title.
- *
- * @param title the new title
- */
- public void setTitle(final String title);
-
- /**
- * Get the width of a character cell in pixels.
- *
- * @return the width in pixels of a character cell
- */
- public int getTextWidth();
-
- /**
- * Get the height of a character cell in pixels.
- *
- * @return the height in pixels of a character cell
- */
- public int getTextHeight();
-
-}
git://git.nikiroo.be / fanfix.git / blobdiff