GetAnchor.3
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:3k
源码类别:

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 1990 The Regents of the University of California.
  3. '" Copyright (c) 1994-1998 Sun Microsystems, Inc.
  4. '"
  5. '" See the file "license.terms" for information on usage and redistribution
  6. '" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  7. '" 
  8. '" RCS: @(#) $Id: GetAnchor.3,v 1.4 2002/08/05 04:30:38 dgp Exp $
  9. '" 
  10. .so man.macros
  11. .TH Tk_GetAnchorFromObj 3 8.1 Tk "Tk Library Procedures"
  12. .BS
  13. .SH NAME
  14. Tk_GetAnchorFromObj, Tk_GetAnchor, Tk_NameOfAnchor - translate between strings and anchor positions
  15. .SH SYNOPSIS
  16. .nf
  17. fB#include <tk.h>fR
  18. .sp
  19. .VS 8.1
  20. int
  21. fBTk_GetAnchorFromObj(fIinterp, objPtr, anchorPtrfB)fR
  22. .VE
  23. .sp
  24. int
  25. fBTk_GetAnchor(fIinterp, string, anchorPtrfB)fR
  26. .sp
  27. CONST char *
  28. fBTk_NameOfAnchor(fIanchorfB)fR
  29. .SH ARGUMENTS
  30. .AS "Tk_Anchor" *anchorPtr
  31. .AP Tcl_Interp *interp in
  32. Interpreter to use for error reporting, or NULL.
  33. .VS 8.1 br
  34. .AP Tcl_Obj *objPtr in/out
  35. String value contains name of anchor point: fBnfR, fBnefR,
  36. fBefR, fBsefR, fBsfR, fBswfR, fBwfR, fBnwfR, or fBcenterfR;
  37. internal rep will be modified to cache corresponding Tk_Anchor.
  38. .AP "CONST char" *string in
  39. Same as fIobjPtrfR except description of anchor point is passed as
  40. a string.
  41. .VE
  42. .AP int *anchorPtr out
  43. Pointer to location in which to store anchor position corresponding to
  44. fIobjPtrfR or fIstringfR.
  45. .AP Tk_Anchor anchor in
  46. Anchor position, e.g. fBTCL_ANCHOR_CENTERfR.
  47. .BE
  48. .SH DESCRIPTION
  49. .PP
  50. .VS 8.1
  51. fBTk_GetAnchorFromObjfR places in fI*anchorPtrfR an anchor position
  52. (enumerated type fBTk_AnchorfR)
  53. corresponding to fIobjPtrfR's value.  The result will be one of
  54. fBTK_ANCHOR_NfR, fBTK_ANCHOR_NEfR, fBTK_ANCHOR_EfR, fBTK_ANCHOR_SEfR,
  55. fBTK_ANCHOR_SfR, fBTK_ANCHOR_SWfR, fBTK_ANCHOR_WfR, fBTK_ANCHOR_NWfR,
  56. or fBTK_ANCHOR_CENTERfR.
  57. Anchor positions are typically used for indicating a point on an object
  58. that will be used to position the object, e.g. fBTK_ANCHOR_NfR means
  59. position the top center point of the object at a particular place.
  60. .PP
  61. Under normal circumstances the return value is fBTCL_OKfR and
  62. fIinterpfR is unused.
  63. If fIstringfR doesn't contain a valid anchor position
  64. or an abbreviation of one of these names, fBTCL_ERRORfR is returned,
  65. fI*anchorPtrfR is unmodified, and an error message is
  66. stored in fIinterpfR's result if fIinterpfR isn't NULL.
  67. fBTk_GetAnchorFromObjfR caches information about the return
  68. value in fIobjPtrfR, which speeds up future calls to
  69. fBTk_GetAnchorFromObjfR with the same fIobjPtrfR.
  70. .PP
  71. fBTk_GetAnchorfR is identical to fBTk_GetAnchorFromObjfR except
  72. that the description of the anchor is specified with a string instead
  73. of an object.  This prevents fBTk_GetAnchorfR from caching the
  74. return value, so fBTk_GetAnchorfR is less efficient than
  75. fBTk_GetAnchorFromObjfR.
  76. .VE
  77. .PP
  78. fBTk_NameOfAnchorfR is the logical inverse of fBTk_GetAnchorfR.
  79. Given an anchor position such as fBTK_ANCHOR_NfR it returns a
  80. statically-allocated string corresponding to fIanchorfR.
  81. If fIanchorfR isn't a legal anchor value, then
  82. ``unknown anchor position'' is returned.
  83. .SH KEYWORDS
  84. anchor position