TextSink.h
上传用户:lctgjx
上传日期:2022-06-04
资源大小:8887k
文件大小:10k
源码类别:

流媒体/Mpeg4/MP4

开发平台:

Visual C++

  1. /*
  2.  * $XConsortium: TextSink.h,v 1.10 94/04/17 20:13:12 kaleb Exp $
  3.  */
  4. /***********************************************************
  5. Copyright (c) 1987, 1988, 1994  X Consortium
  6. Permission is hereby granted, free of charge, to any person obtaining a copy
  7. of this software and associated documentation files (the "Software"), to deal
  8. in the Software without restriction, including without limitation the rights
  9. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10. copies of the Software, and to permit persons to whom the Software is
  11. furnished to do so, subject to the following conditions:
  12. The above copyright notice and this permission notice shall be included in
  13. all copies or substantial portions of the Software.
  14. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
  17. X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  18. AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  19. CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  20. Except as contained in this notice, the name of the X Consortium shall not be
  21. used in advertising or otherwise to promote the sale, use or other dealings
  22. in this Software without prior written authorization from the X Consortium.
  23. Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts.
  24.                         All Rights Reserved
  25. Permission to use, copy, modify, and distribute this software and its 
  26. documentation for any purpose and without fee is hereby granted, 
  27. provided that the above copyright notice appear in all copies and that
  28. both that copyright notice and this permission notice appear in 
  29. supporting documentation, and that the name of Digital not be
  30. used in advertising or publicity pertaining to distribution of the
  31. software without specific, written prior permission.  
  32. DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  33. ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  34. DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  35. ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  36. WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  37. ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  38. SOFTWARE.
  39. ******************************************************************/
  40. #ifndef _XawTextSink_h
  41. #define _XawTextSink_h
  42. #include <X11/Xaw3d/Text.h>
  43. /***********************************************************************
  44.  *
  45.  * TextSink Object
  46.  *
  47.  ***********************************************************************/
  48. /* Resources:
  49.  Name      Class RepType Default Value
  50.  ----      ----- ------- -------------
  51.  foreground          Foreground      Pixel              XtDefaultForeground
  52.  background          Background      Pixel              XtDefaultBackground
  53. */
  54.  
  55. /* Class record constants */
  56. extern WidgetClass textSinkObjectClass;
  57. typedef struct _TextSinkClassRec *TextSinkObjectClass;
  58. typedef struct _TextSinkRec      *TextSinkObject;
  59. typedef enum {XawisOn, XawisOff} XawTextInsertState;
  60. /************************************************************
  61.  *
  62.  * Public Functions.
  63.  *
  64.  ************************************************************/
  65. _XFUNCPROTOBEGIN
  66. /* Function Name: XawTextSinkDisplayText
  67.  * Description: Stub function that in subclasses will display text. 
  68.  * Arguments: w - the TextSink Object.
  69.  *                 x, y - location to start drawing text.
  70.  *                 pos1, pos2 - location of starting and ending points
  71.  *                              in the text buffer.
  72.  *                 highlight - hightlight this text?
  73.  * Returns: none.
  74.  *
  75.  * This function doesn't actually display anything, it is only a place
  76.  * holder.
  77.  */
  78. extern void XawTextSinkDisplayText(
  79. #if NeedFunctionPrototypes
  80.     Widget /* w */,
  81. #if NeedWidePrototypes
  82.     /* Position */ int /* x */,
  83.     /* Position */ int /* y */,
  84. #else
  85.     Position /* x */,
  86.     Position /* y */,
  87. #endif
  88.     XawTextPosition /* pos1 */,
  89.     XawTextPosition /* pos2 */,
  90. #if NeedWidePrototypes
  91.     /* Boolean */ int /* highlight */
  92. #else
  93.     Boolean /* highlight */
  94. #endif
  95. #endif
  96. );
  97. /* Function Name: XawTextSinkInsertCursor
  98.  * Description: Places the InsertCursor.
  99.  * Arguments: w - the TextSink Object.
  100.  *                 x, y - location for the cursor.
  101.  *                 staye - whether to turn the cursor on, or off.
  102.  * Returns: none.
  103.  *
  104.  * This function doesn't actually display anything, it is only a place
  105.  * holder.
  106.  */
  107. extern void XawTextSinkInsertCursor(
  108. #if NeedFunctionPrototypes
  109.     Widget /* w */,
  110. #if NeedWidePrototypes
  111.     /* Position */ int /* x */,
  112.     /* Position */ int /* y */,
  113.     /* XawTextInsertState */ int /* state */
  114. #else
  115.     Position /* x */,
  116.     Position /* y */,
  117.     XawTextInsertState /* state */
  118. #endif
  119. #endif
  120. );
  121. /* Function Name: XawTextSinkClearToBackground
  122.  * Description: Clears a region of the sink to the background color.
  123.  * Arguments: w - the TextSink Object.
  124.  *                 x, y  - location of area to clear.
  125.  *                 width, height - size of area to clear
  126.  * Returns: void.
  127.  *
  128.  * This function doesn't actually display anything, it is only a place
  129.  * holder.
  130.  */
  131. extern void XawTextSinkClearToBackground(
  132. #if NeedFunctionPrototypes
  133.     Widget /* w */,
  134. #if NeedWidePrototypes
  135.     /* Position */ int /* x */,
  136.     /* Position */ int /* y */,
  137.     /* Dimension */ int /* width */,
  138.     /* Dimension */ int /* height */
  139. #else
  140.     Position /* x */,
  141.     Position /* y */,
  142.     Dimension /* width */,
  143.     Dimension /* height */
  144. #endif
  145. #endif
  146. );
  147. /* Function Name: XawTextSinkFindPosition
  148.  * Description: Finds a position in the text.
  149.  * Arguments: w - the TextSink Object.
  150.  *                 fromPos - reference position.
  151.  *                 fromX   - reference location.
  152.  *                 width,  - width of section to paint text.
  153.  *                 stopAtWordBreak - returned position is a word break?
  154.  *                 resPos - Position to return.      *** RETURNED ***
  155.  *                 resWidth - Width actually used.   *** RETURNED ***
  156.  *                 resHeight - Height actually used. *** RETURNED ***
  157.  * Returns: none (see above).
  158.  */
  159. extern void XawTextSinkFindPosition(
  160. #if NeedFunctionPrototypes
  161.     Widget /* w */,
  162.     XawTextPosition /* fromPos */,
  163.     int /* fromX */,
  164.     int /* width */,
  165. #if NeedWidePrototypes
  166.     /* Boolean */ int /* stopAtWordBreak */,
  167. #else
  168.     Boolean /* stopAtWordBreak */,
  169. #endif
  170.     XawTextPosition* /* pos_return */,
  171.     int* /* width_return */,
  172.     int* /* height_return */
  173. #endif
  174. );
  175. /* Function Name: XawTextSinkFindDistance
  176.  * Description: Find the Pixel Distance between two text Positions.
  177.  * Arguments: w - the TextSink Object.
  178.  *                 fromPos - starting Position.
  179.  *                 fromX   - x location of starting Position.
  180.  *                 toPos   - end Position.
  181.  *                 resWidth - Distance between fromPos and toPos.
  182.  *                 resPos   - Acutal toPos used.
  183.  *                 resHeight - Height required by this text.
  184.  * Returns: none.
  185.  */
  186. extern void XawTextSinkFindDistance (
  187. #if NeedFunctionPrototypes
  188.     Widget /* w */,
  189.     XawTextPosition /* fromPos */,
  190.     int /* fromX */,
  191.     XawTextPosition     /* toPos */,
  192.     int* /* width_return */,
  193.     XawTextPosition* /* pos_return */,
  194.     int* /* height_return */
  195. #endif
  196. );
  197. /* Function Name: XawTextSinkResolve
  198.  * Description: Resloves a location to a position.
  199.  * Arguments: w - the TextSink Object.
  200.  *                 pos - a reference Position.
  201.  *                 fromx - a reference Location.
  202.  *                 width - width to move.
  203.  *                 resPos - the resulting position.
  204.  * Returns: none
  205.  */
  206. extern void XawTextSinkResolve(
  207. #if NeedFunctionPrototypes
  208.     Widget /* w */,
  209.     XawTextPosition /* fromPos */,
  210.     int /* fromX */,
  211.     int /* width */,
  212.     XawTextPosition* /* pos_return */
  213. #endif
  214. );
  215. /* Function Name: XawTextSinkMaxLines
  216.  * Description: Finds the Maximum number of lines that will fit in
  217.  *                   a given height.
  218.  * Arguments: w - the TextSink Object.
  219.  *                 height - height to fit lines into.
  220.  * Returns: the number of lines that will fit.
  221.  */
  222. extern int XawTextSinkMaxLines(
  223. #if NeedFunctionPrototypes
  224.     Widget /* w */,
  225. #if NeedWidePrototypes
  226.     /* Dimension */ int /* height */
  227. #else
  228.     Dimension /* height */
  229. #endif
  230. #endif
  231. );
  232. /* Function Name: XawTextSinkMaxHeight
  233.  * Description: Finds the Minium height that will contain a given number 
  234.  *                   lines.
  235.  * Arguments: w - the TextSink Object.
  236.  *                 lines - the number of lines.
  237.  * Returns: the height.
  238.  */
  239. extern int XawTextSinkMaxHeight(
  240. #if NeedFunctionPrototypes
  241.     Widget /* w */,
  242.     int /* lines */
  243. #endif
  244. );
  245. /* Function Name: XawTextSinkSetTabs
  246.  * Description: Sets the Tab stops.
  247.  * Arguments: w - the TextSink Object.
  248.  *                 tab_count - the number of tabs in the list.
  249.  *                 tabs - the text positions of the tabs.
  250.  * Returns: none
  251.  */
  252. extern void XawTextSinkSetTabs(
  253. #if NeedFunctionPrototypes
  254.     Widget /* w */,
  255.     int /* tab_count */,
  256.     int* /* tabs */
  257. #endif
  258. );
  259.   
  260. /* Function Name: XawTextSinkGetCursorBounds
  261.  * Description: Finds the bounding box for the insert curor (caret).
  262.  * Arguments: w - the TextSinkObject.
  263.  *                 rect - an X rectance containing the cursor bounds.
  264.  * Returns: none (fills in rect).
  265.  */
  266. extern void XawTextSinkGetCursorBounds(
  267. #if NeedFunctionPrototypes
  268.     Widget /* w */,
  269.     XRectangle* /* rect_return */
  270. #endif
  271. );
  272. _XFUNCPROTOEND
  273. #endif /* _XawTextSrc_h */