749N/A/*
749N/A * $XConsortium: TextSink.h,v 1.5 89/11/01 17:28:26 kit Exp $
749N/A */
749N/A
749N/A/***********************************************************
749N/ACopyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
749N/Aand the Massachusetts Institute of Technology, Cambridge, Massachusetts.
749N/A
749N/A All Rights Reserved
749N/A
749N/APermission to use, copy, modify, and distribute this software and its
749N/Adocumentation for any purpose and without fee is hereby granted,
749N/Aprovided that the above copyright notice appear in all copies and that
749N/Aboth that copyright notice and this permission notice appear in
749N/Asupporting documentation, and that the names of Digital or MIT not be
749N/Aused in advertising or publicity pertaining to distribution of the
749N/Asoftware without specific, written prior permission.
749N/A
749N/ADIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
749N/AALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
749N/ADIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
749N/AANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
749N/AWHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
749N/AARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
749N/ASOFTWARE.
749N/A
749N/A******************************************************************/
749N/A
749N/A#ifndef _XawTextSink_h
749N/A#define _XawTextSink_h
749N/A
749N/A/***********************************************************************
749N/A *
749N/A * TextSink Object
749N/A *
749N/A ***********************************************************************/
749N/A
749N/A#include <X11/Object.h>
749N/A
749N/A/* Resources:
749N/A
749N/A Name Class RepType Default Value
749N/A ---- ----- ------- -------------
749N/A font Font XFontStruct * XtDefaultFont
749N/A foreground Foreground Pixel XtDefaultForeground
749N/A background Background Pixel XtDefaultBackground
749N/A
749N/A*/
749N/A
749N/A/* Class record constants */
749N/A
749N/Aextern WidgetClass textSinkObjectClass;
749N/A
749N/Atypedef struct _TextSinkClassRec *TextSinkObjectClass;
749N/Atypedef struct _TextSinkRec *TextSinkObject;
749N/A
749N/Atypedef enum {XawisOn, XawisOff} XawTextInsertState;
749N/A
749N/A/************************************************************
749N/A *
749N/A * Public Functions.
749N/A *
749N/A ************************************************************/
749N/A
749N/A/* Function Name: XawTextSinkDisplayText
749N/A * Description: Stub function that in subclasses will display text.
749N/A * Arguments: w - the TextSink Object.
749N/A * x, y - location to start drawing text.
749N/A * pos1, pos2 - location of starting and ending points
749N/A * in the text buffer.
749N/A * highlight - hightlight this text?
749N/A * Returns: none.
749N/A *
749N/A * This function doesn't actually display anything, it is only a place
749N/A * holder.
749N/A */
749N/A
749N/Avoid XawTextSinkDisplayText(/* w, x, y, pos1, pos2, highlight */);
749N/A/*
749N/AWidget w;
749N/APosition x, y;
749N/ABoolean highlight;
749N/AXawTextPosition pos1, pos2;
749N/A*/
749N/A
749N/A/* Function Name: XawTextSinkInsertCursor
749N/A * Description: Places the InsertCursor.
749N/A * Arguments: w - the TextSink Object.
749N/A * x, y - location for the cursor.
749N/A * staye - whether to turn the cursor on, or off.
749N/A * Returns: none.
749N/A *
749N/A * This function doesn't actually display anything, it is only a place
749N/A * holder.
749N/A */
749N/A
749N/Avoid XawTextSinkInsertCursor( /* w, x, y, state */ );
749N/A/*
749N/AWidget w;
749N/APosition x, y;
749N/AXawTextInsertState state;
749N/A*/
749N/A
749N/A/* Function Name: XawTextSinkClearToBackground
749N/A * Description: Clears a region of the sink to the background color.
749N/A * Arguments: w - the TextSink Object.
749N/A * x, y - location of area to clear.
749N/A * width, height - size of area to clear
749N/A * Returns: void.
749N/A *
749N/A * This function doesn't actually display anything, it is only a place
749N/A * holder.
749N/A */
749N/A
749N/Avoid XawTextSinkClearToBackground (/* w, x, y, width, height */);
749N/A/*
749N/AWidget w;
749N/APosition x, y;
749N/ADimension width, height;
749N/A*/
749N/A
749N/A/* Function Name: XawTextSinkFindPosition
749N/A * Description: Finds a position in the text.
749N/A * Arguments: w - the TextSink Object.
749N/A * fromPos - reference position.
749N/A * fromX - reference location.
749N/A * width, - width of section to paint text.
749N/A * stopAtWordBreak - returned position is a word break?
749N/A * resPos - Position to return. *** RETURNED ***
749N/A * resWidth - Width actually used. *** RETURNED ***
749N/A * resHeight - Height actually used. *** RETURNED ***
749N/A * Returns: none (see above).
749N/A */
749N/A
749N/Avoid XawTextSinkFindPosition(/* w, fromPos, fromx, width, stopAtWordBreak,
749N/A resPos, resWidth, resHeight */ );
749N/A/*
749N/AWidget w;
749N/AXawTextPosition fromPos;
749N/Aint fromx, width;
749N/ABoolean stopAtWordBreak;
749N/AXawTextPosition *resPos;
749N/Aint *resWidth, *resHeight;
749N/A*/
749N/A
749N/A/* Function Name: XawTextSinkFindDistance
749N/A * Description: Find the Pixel Distance between two text Positions.
749N/A * Arguments: w - the TextSink Object.
749N/A * fromPos - starting Position.
749N/A * fromX - x location of starting Position.
749N/A * toPos - end Position.
749N/A * resWidth - Distance between fromPos and toPos.
749N/A * resPos - Acutal toPos used.
749N/A * resHeight - Height required by this text.
749N/A * Returns: none.
749N/A */
749N/A
749N/Avoid XawTextSinkFindDistance (/* w, fromPos, fromx,
749N/A toPos, resWidth, resPos, resHeight */);
749N/A/*
749N/AWidget w;
749N/AXawTextPosition fromPos, toPos, *resPos;
749N/Aint fromx, *resWidth, *resHeight;
749N/A*/
749N/A
749N/A/* Function Name: XawTextSinkResolve
749N/A * Description: Resloves a location to a position.
749N/A * Arguments: w - the TextSink Object.
749N/A * pos - a reference Position.
749N/A * fromx - a reference Location.
749N/A * width - width to move.
749N/A * resPos - the resulting position.
749N/A * Returns: none
749N/A */
749N/A
749N/Avoid XawTextSinkResolve(/* w, pos, fromx, width, resPos */);
749N/A/*
749N/AWidget w;
749N/AXawTextPosition pos;
749N/Aint fromx, width;
749N/AXawTextPosition *resPos;
749N/A*/
749N/A
749N/A/* Function Name: XawTextSinkMaxLines
749N/A * Description: Finds the Maximum number of lines that will fit in
749N/A * a given height.
749N/A * Arguments: w - the TextSink Object.
749N/A * height - height to fit lines into.
749N/A * Returns: the number of lines that will fit.
749N/A */
749N/A
749N/Aint XawTextSinkMaxLines(/* w, height */);
749N/A/*
749N/AWidget w;
749N/ADimension height;
749N/A*/
749N/A
749N/A/* Function Name: XawTextSinkMaxHeight
749N/A * Description: Finds the Minium height that will contain a given number
749N/A * lines.
749N/A * Arguments: w - the TextSink Object.
749N/A * lines - the number of lines.
749N/A * Returns: the height.
749N/A */
749N/A
749N/Aint XawTextSinkMaxHeight(/* w, lines */);
749N/A/*
749N/AWidget w;
749N/Aint lines;
749N/A*/
749N/A
749N/A/* Function Name: XawTextSinkSetTabs
749N/A * Description: Sets the Tab stops.
749N/A * Arguments: w - the TextSink Object.
749N/A * tab_count - the number of tabs in the list.
749N/A * tabs - the text positions of the tabs.
749N/A * Returns: none
749N/A */
749N/A
749N/Avoid XawTextSinkSetTabs(/* w, tab_count, tabs */);
749N/A/*
749N/AWidget w;
749N/Aint tab_count, *tabs;
749N/A*/
749N/A
749N/A/* Function Name: XawTextSinkGetCursorBounds
749N/A * Description: Finds the bounding box for the insert curor (caret).
749N/A * Arguments: w - the TextSinkObject.
749N/A * rect - an X rectance containing the cursor bounds.
749N/A * Returns: none (fills in rect).
749N/A */
749N/A
749N/Avoid XawTextSinkGetCursorBounds(/* w, rect */);
749N/A/*
749N/AWidget w;
749N/AXRectangle * rect;
749N/A*/
749N/A
749N/A#endif /* _XawTextSrc_h -- DON'T ADD STUFF AFTER THIS #endif */