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

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 1994 The Regents of the University of California.
  3. '" Copyright (c) 1994-1996 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: clipboard.n,v 1.5.2.1 2004/10/28 10:19:29 dkf Exp $
  9. '" 
  10. .so man.macros
  11. .TH clipboard n 8.4 Tk "Tk Built-In Commands"
  12. .BS
  13. '" Note:  do not modify the .SH NAME line immediately below!
  14. .SH NAME
  15. clipboard - Manipulate Tk clipboard
  16. .SH SYNOPSIS
  17. fBclipboard fIoptionfR ?fIarg arg ...fR?
  18. .BE
  19. .SH DESCRIPTION
  20. .PP
  21. This command provides a Tcl interface to the Tk clipboard,
  22. which stores data for later retrieval using the selection mechanism 
  23. (via the fB-selection CLIPBOARDfR option).
  24. In order to copy data into the clipboard, fBclipboard clearfR must
  25. be called, followed by a sequence of one or more calls to fBclipboard
  26. appendfR.  To ensure that the clipboard is updated atomically, all
  27. appends should be completed before returning to the event loop.
  28. .PP
  29. The first argument to fBclipboardfR determines the format of the
  30. rest of the arguments and the behavior of the command.  The following
  31. forms are currently supported:
  32. .PP
  33. .TP
  34. fBclipboard clearfR ?fB-displayoffR fIwindowfR?
  35. Claims ownership of the clipboard on fIwindowfR's display and removes
  36. any previous contents.  fIWindowfR defaults to ``.''.  Returns an
  37. empty string.
  38. .TP
  39. fBclipboard appendfR ?fB-displayoffR fIwindowfR? ?fB-formatfR fIformatfR? ?fB-typefR fItypefR? ?fB-|-fR? fIdatafR
  40. Appends fIdatafR to the clipboard on fIwindowfR's
  41. display in the form given by fItypefR with the representation given
  42. by fIformatfR and claims ownership of the clipboard on fIwindowfR's
  43. display.
  44. .RS
  45. .PP
  46. fITypefR specifies the form in which the selection is to be returned
  47. (the desired ``target'' for conversion, in ICCCM terminology), and
  48. should be an atom name such as STRING or FILE_NAME; see the
  49. Inter-Client Communication Conventions Manual for complete details.
  50. fITypefR defaults to STRING.
  51. .PP
  52. The fIformatfR argument specifies the representation that should be
  53. used to transmit the selection to the requester (the second column of
  54. Table 2 of the ICCCM), and defaults to STRING.  If fIformatfR is
  55. STRING, the selection is transmitted as 8-bit ASCII characters.  If
  56. fIformatfR is ATOM, then the fIdatafR is
  57. divided into fields separated by white space; each field is converted
  58. to its atom value, and the 32-bit atom value is transmitted instead of
  59. the atom name.  For any other fIformatfR,  fIdatafR is divided
  60. into fields separated by white space and each 
  61. field is converted to a 32-bit integer; an array of integers is
  62. transmitted to the selection requester.  Note that strings passed to
  63. fBclipboard appendfR are concatenated before conversion, so the
  64. caller must take care to ensure appropriate spacing across string
  65. boundaries.  All items appended to the clipboard with the same
  66. fItypefR must have the same fIformatfR.
  67. .PP
  68. The fIformatfR argument is needed only for compatibility with
  69. clipboard requesters that don't use Tk.  If the Tk toolkit is being
  70. used to retrieve the CLIPBOARD selection then the value is converted back to
  71. a string at the requesting end, so fIformatfR is
  72. irrelevant.
  73. .PP
  74. A fB-|-fR argument may be specified to mark the end of options:  the
  75. next argument will always be used as fIdatafR.
  76. This feature may be convenient if, for example, fIdatafR starts
  77. with a fB-fR.
  78. .RE
  79. .TP
  80. fBclipboard getfR ?fB-displayoffR fIwindowfR? ?fB-typefR fItypefR?
  81. .VS 8.4
  82. Retrieve data from the clipboard on fIwindowfR's display.
  83. fIwindowfR defaults to ".".  fITypefR specifies the form in which
  84. the data is to be returned and should be an atom name such as STRING
  85. or FILE_NAME.  fITypefR defaults to STRING.  This command is
  86. equivalent to fBselection get -selection CLIPBOARDfR.
  87. .VE 8.4
  88. .SH EXAMPLES
  89. Get the current contents of the clipboard.
  90. .CS
  91. if {[catch {fBclipboard getfR} contents]} {
  92.     # There were no clipboard contents at all
  93. }
  94. .CE
  95. .PP
  96. Set the clipboard to contain a fixed string.
  97. .CS
  98. fBclipboard clearfR
  99. fBclipboard appendfR "some fixed string"
  100. .CE
  101. .SH "SEE ALSO"
  102. selection(n)
  103. .SH KEYWORDS
  104. clear, format, clipboard, append, selection, type