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

流媒体/Mpeg4/MP4

开发平台:

Visual C++

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