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

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 1990-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: GetSelect.3,v 1.2 1998/09/14 18:22:51 stanton Exp $
  9. '" 
  10. .so man.macros
  11. .TH Tk_GetSelection 3 4.0 Tk "Tk Library Procedures"
  12. .BS
  13. .SH NAME
  14. Tk_GetSelection - retrieve the contents of a selection
  15. .SH SYNOPSIS
  16. .nf
  17. fB#include <tk.h>fR
  18. .sp
  19. int
  20. fBTk_GetSelectionfR(fIinterp, tkwin, selection, target, proc, clientDatafR)
  21. .SH ARGUMENTS
  22. .AS Tk_GetSelProc clientData
  23. .AP Tcl_Interp *interp in
  24. Interpreter to use for reporting errors.
  25. .AP Tk_Window tkwin in
  26. Window on whose behalf to retrieve the selection (determines
  27. display from which to retrieve).
  28. .AP Atom selection in
  29. The name of the selection to be retrieved.
  30. .AP Atom target in
  31. Form in which to retrieve selection.
  32. .AP Tk_GetSelProc *proc in
  33. Procedure to invoke to process pieces of the selection as they
  34. are retrieved.
  35. .AP ClientData clientData in
  36. Arbitrary one-word value to pass to fIprocfR.
  37. .BE
  38. .SH DESCRIPTION
  39. .PP
  40. fBTk_GetSelectionfR retrieves the selection specified by the atom
  41. fIselectionfR in the format specified by fItargetfR.  The
  42. selection may actually be retrieved in several pieces; as each piece
  43. is retrieved, fIprocfR is called to process the piece.  fIProcfR
  44. should have arguments and result that match the type
  45. fBTk_GetSelProcfR:
  46. .CS
  47. typedef int Tk_GetSelProc(
  48. ClientData fIclientDatafR,
  49. Tcl_Interp *fIinterpfR,
  50. char *fIportionfR);
  51. .CE
  52. The fIclientDatafR and fIinterpfR parameters to fIprocfR 
  53. will be copies of the corresponding arguments to
  54. fBTk_GetSelectionfR.  fIPortionfR will be a pointer to
  55. a string containing part or all of the selection.  For large
  56. selections, fIprocfR will be called several times with successive
  57. portions of the selection.  The X Inter-Client Communication
  58. Conventions Manual allows a selection to be returned in formats
  59. other than strings, e.g. as an array of atoms or integers.  If
  60. this happens, Tk converts the selection back into a string
  61. before calling fIprocfR.  If a selection is returned as an
  62. array of atoms, Tk converts it to a string containing the atom names
  63. separated by white space.  For any other format besides string,
  64. Tk converts a selection to a string containing hexadecimal
  65. values separated by white space.
  66. .PP
  67. fBTk_GetSelectionfR returns to its caller when the selection has
  68. been completely retrieved and processed by fIprocfR, or when a
  69. fatal error has occurred (e.g. the selection owner didn't respond
  70. promptly).  fBTk_GetSelectionfR normally returns TCL_OK;  if
  71. an error occurs, it returns TCL_ERROR and leaves an error message
  72. in fIinterp->resultfR.  fIProcfR should also return either
  73. TCL_OK or TCL_ERROR. If fIprocfR encounters an error in dealing with the
  74. selection, it should leave an error message in fIinterp->resultfR
  75. and return TCL_ERROR;  this will abort the selection retrieval.
  76. .SH KEYWORDS
  77. format, get, selection retrieval