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

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 1992 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: panedwindow.n,v 1.2.2.3 2004/12/20 10:03:17 dkf Exp $
  9. '" 
  10. .so man.macros
  11. .TH panedwindow 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. panedwindow - Create and manipulate panedwindow widgets
  16. .SH SYNOPSIS
  17. fBpanedwindowfR fIpathName fR?fIoptionsfR?
  18. .SO
  19. -background -height -width
  20. -borderwidth -orient
  21. -cursor -relief
  22. .SE
  23. .SH "WIDGET-SPECIFIC OPTIONS"
  24. .OP -handlepad handlePad HandlePad
  25. When sash handles are drawn, specifies the distance from the top or
  26. left end of the sash (depending on the orientation of the widget) at
  27. which to draw the handle.  May be any value accepted by fBTk_GetPixelsfR.
  28. .OP -handlesize handleSize HandleSize
  29. Specifies the side length of a sash handle.  Handles are always
  30. drawn as squares.  May be any value accepted by fBTk_GetPixelsfR.
  31. .OP -opaqueresize opaqueResize OpaqueResize
  32. Specifies whether panes should be resized as a sash is moved (true),
  33. or if resizing should be deferred until the sash is placed (false).
  34. .OP -sashcursor sashCursor SashCursor
  35. Mouse cursor to use when over a sash.  If null,
  36. fBsb_h_double_arrowfR will be used for horizontal panedwindows, and
  37. fBsb_v_double_arrowfR will be used for vertical panedwindows.
  38. .OP -sashpad sashPad SashPad
  39. Specifies the amount of padding to leave of each side of a sash.  May
  40. be any value accepted by fBTk_GetPixelsfR.
  41. .OP -sashrelief sashRelief SashRelief
  42. Relief to use when drawing a sash.  May be any of the standard Tk
  43. relief values.
  44. .OP -sashwidth sashWidth SashWidth
  45. Specifies the width of each sash.  May be any value accepted by
  46. fBTk_GetPixelsfR.
  47. .OP -showhandle showHandle ShowHandle
  48. Specifies whether sash handles should be shown.  May be any valid Tcl
  49. boolean value.
  50. .BE
  51. .SH DESCRIPTION
  52. .PP
  53. The fBpanedwindowfR command creates a new window (given by the
  54. fIpathNamefR argument) and makes it into a panedwindow widget.
  55. Additional options, described above, may be specified on the command
  56. line or in the option database to configure aspects of the panedwindow
  57. such as its default background color and relief.  The
  58. fBpanedwindowfR command returns the path name of the new window.
  59. .PP
  60. A panedwindow widget contains any number of panes, arranged
  61. horizontally or vertically, according to the value of the
  62. fB-orientfR option.  Each pane contains one widget, and each pair of
  63. panes is separated by a moveable (via mouse movements) sash.  Moving a
  64. sash causes the widgets on either side of the sash to be resized.
  65. .SH "WIDGET COMMAND"
  66. .PP
  67. The fBpanedwindowfR command creates a new Tcl command whose name is
  68. the same as the path name of the panedwindow's window.  This command
  69. may be used to invoke various operations on the widget.  It has the
  70. following general form:
  71. .CS
  72. fIpathName option fR?fIarg arg ...fR?
  73. .CE
  74. fIPathNamefR is the name of the command, which is the same as
  75. the panedwindow widget's path name.  fIOptionfR and the fIargfRs
  76. determine the exact behavior of the command.  The following
  77. commands are possible for panedwindow widgets:
  78. .TP
  79. fIpathName fBadd fIwindow ?window ...? ?option value ...?fR
  80. Add one or more windows to the panedwindow, each in a separate pane.
  81. The arguments consist of the names of one or more windows
  82. followed by pairs of arguments that specify how to manage the windows.
  83. fIOptionfR may have any of the values accepted by the
  84. fBconfigurefR subcommand.
  85. .TP
  86. fIpathName fBcget fIoptionfR
  87. Returns the current value of the configuration option given by
  88. fIoptionfR.  fIOptionfR may have any of the values accepted by the
  89. fBpanedwindowfR command.
  90. .TP
  91. fIpathName fBconfigure fI?option? ?value option value ...?fR
  92. Query or modify the configuration options of the widget.  If no
  93. fIoptionfR is specified, returns a list describing all of the
  94. available options for fIpathNamefR (see fBTk_ConfigureInfofR for
  95. information on the format of this list).  If fIoptionfR is specified
  96. with no fIvaluefR, then the command returns a list describing the
  97. one named option (this list will be identical to the corresponding
  98. sublist of the value returned if no fIoptionfR is specified).  If
  99. one or more fIoption-valuefR pairs are specified, then the command
  100. modifies the given widget option(s) to have the given value(s);  in
  101. this case the command returns an empty string. fIOptionfR may have
  102. any of the values accepted by the fBpanedwindowfR command.
  103. .TP
  104. fIpathName fBforget fIwindow ?window ...?fR
  105. Remove the pane containing fIwindowfR from the panedwindow.  All
  106. geometry management options for fIwindowfR will be forgotten.
  107. .TP
  108. fIpathName fBidentify fIx yfR
  109. Identify the panedwindow component underneath the point given by
  110. fIxfR and fIyfR, in window coordinates.  If the point is over a
  111. sash or a sash handle, the result is a two element list containing the
  112. index of the sash or handle, and a word indicating whether it is over
  113. a sash or a handle, such as {0 sash} or {2 handle}.  If the point is
  114. over any other part of the panedwindow, the result is an empty list.
  115. .TP
  116. fIpathName fBproxy fI?args?fR
  117. This command is used to query and change the position of the sash
  118. proxy, used for rubberband-style pane resizing. It can take any of
  119. the following forms:
  120. .RS
  121. .TP
  122. fIpathName fBproxy coordfR
  123. Return a list containing the x and y coordinates of the most recent
  124. proxy location.
  125. .TP
  126. fIpathName fBproxy forgetfR
  127. Remove the proxy from the display.
  128. .TP
  129. fIpathName fBproxy place fIx yfR
  130. Place the proxy at the given fIxfR and fIyfR coordinates.  
  131. .RE
  132. .TP
  133. fIpathName fBsash fI?args?fR
  134. This command is used to query and change the position of sashes in the
  135. panedwindow.  It can take any of the following forms:
  136. .RS
  137. .TP
  138. fIpathName fBsash coord fIindexfR
  139. Return the current x and y coordinate pair for the sash given by
  140. fIindexfR.  fIIndexfR must be an integer between 0 and 1 less than
  141. the number of panes in the panedwindow.  The coordinates given are
  142. those of the top left corner of the region containing the sash.
  143. .TP
  144. fIpathName fBsash dragto fIindex x yfR
  145. This command computes the difference between the given coordinates and the
  146. coordinates given to the last fBsash markfR command for the given
  147. sash.  It then moves that sash the computed difference.  The return
  148. value is the empty string.
  149. .TP
  150. fIpathName fBsash mark fIindex x yfR
  151. Records fIxfR and fIyfR for the sash given by fIindexfR; used in
  152. conjunction with later fBsash dragtofR commands to move the sash.
  153. .TP
  154. fIpathName fBsash place fIindex x yfR
  155. Place the sash given by fIindexfR at the given coordinates.
  156. .RE
  157. .TP
  158. fIpathName fBpanecget fIwindow optionfR
  159. Query a management option for fIwindowfR.  fIOptionfR may be any
  160. value allowed by the fBpaneconfigurefR subcommand.
  161. .TP
  162. fIpathName fBpaneconfigure fIwindow ?option? ?value option value ...?fR
  163. Query or modify the management options for fIwindowfR.  If no
  164. fIoptionfR is specified, returns a list describing all of the
  165. available options for fIpathNamefR (see fBTk_ConfigureInfofR for
  166. information on the format of this list).  If fIoptionfR is specified
  167. with no fIvaluefR, then the command returns a list describing the
  168. one named option (this list will be identical to the corresponding
  169. sublist of the value returned if no fIoptionfR is specified).  If
  170. one or more fIoption-valuefR pairs are specified, then the command
  171. modifies the given widget option(s) to have the given value(s);  in
  172. this case the command returns an empty string.  The following options
  173. are supported:
  174. .RS
  175. .TP
  176. fB-after fIwindowfR
  177. Insert the window after the window specified.  fIwindowfR should be the
  178. name of a window already managed by fIpathNamefR.
  179. .TP
  180. fB-before fIwindowfR
  181. Insert the window before the window specified.  fIwindowfR should be
  182. the name of a window already managed by fIpathNamefR.
  183. .TP
  184. fB-height fIsizefR
  185. Specify a height for the window.  The height will be the outer
  186. dimension of the window including its border, if any.  If fIsizefR
  187. is an empty string, or if fB-heightfR is not specified, then the
  188. height requested internally by the window will be used initially; the
  189. height may later be adjusted by the movement of sashes in the
  190. panedwindow.  fISizefR may be any value accepted by fBTk_GetPixelsfR.
  191. .TP
  192. fB-minsize fInfR
  193. Specifies that the size of the window cannot be made less than
  194. fInfR.  This constraint only affects the size of the widget in the
  195. paned dimension -- the x dimension for horizontal panedwindows, the y
  196. dimension for vertical panedwindows.  May be any value accepted by
  197. fBTk_GetPixelsfR.
  198. .TP
  199. fB-padx fInfR
  200. Specifies a non-negative value indicating how much extra space to
  201. leave on each side of the window in the X-direction.  The value may 
  202. have any of the forms accepted by fBTk_GetPixelsfR.
  203. .TP
  204. fB-pady fInfR
  205. Specifies a non-negative value indicating how much extra space to
  206. leave on each side of the window in the Y-direction.  The value may 
  207. have any of the forms accepted by fBTk_GetPixelsfR.
  208. .TP
  209. fB-sticky fIstylefR
  210. If a window's pane is larger than the requested dimensions of the
  211. window, this option may be used to position (or stretch) the window
  212. within its pane.  fIStylefR  is a string that contains zero or more
  213. of the characters fBnfP, fBsfP, fBefP or fBwfP.  The string
  214. can optionally contains spaces or commas, but they are ignored.  Each
  215. letter refers to a side (north, south, east, or west) that the window
  216. will "stick" to.  If both fBnfP and fBsfP (or fBefP and fBwfP)
  217. are specified, the window will be stretched to fill the entire height
  218. (or width) of its cavity.
  219. .TP
  220. fB-width fIsizefR
  221. Specify a width for the window.  The width will be the outer
  222. dimension of the window including its border, if any.  If fIsizefR
  223. is an empty string, or if fB-widthfR is not specified, then the
  224. width requested internally by the window will be used initially; the
  225. width may later be adjusted by the movement of sashes in the
  226. panedwindow.  fISizefR may be any value accepted by fBTk_GetPixelsfR.
  227. .RE
  228. .TP
  229. fIpathName fBpanesfR
  230. Returns an ordered list of the widgets managed by fIpathNamefR.
  231. .SH "RESIZING PANES"
  232. A pane is resized by grabbing the sash (or sash handle if present) and
  233. dragging with the mouse.  This is accomplished via mouse motion
  234. bindings on the widget.  When a sash is moved, the sizes of the panes
  235. on each side of the sash, and thus the widgets in those panes, are
  236. adjusted.
  237. .PP
  238. When a pane is resized from outside (e.g. it is packed to expand and
  239. fill, and the containing toplevel is resized), space is added to the final
  240. (rightmost or bottommost) pane in the window.
  241. .SH KEYWORDS
  242. panedwindow, widget, geometry management