From 38ef6a506f242815f3c11aaa905f65d68dd5793c Mon Sep 17 00:00:00 2001 From: patthoyts Date: Fri, 9 May 2008 18:34:59 +0000 Subject: Document the identify command as present on all ttk widgets --- ChangeLog | 4 ++++ doc/ttk_button.n | 15 +++++---------- doc/ttk_checkbutton.n | 4 ++-- doc/ttk_combobox.n | 6 +++--- doc/ttk_frame.n | 4 ++-- doc/ttk_label.n | 14 ++++---------- doc/ttk_labelframe.n | 4 ++-- doc/ttk_menubutton.n | 4 ++-- doc/ttk_notebook.n | 6 +++++- doc/ttk_panedwindow.n | 10 +++++----- doc/ttk_progressbar.n | 6 +++++- doc/ttk_radiobutton.n | 4 ++-- doc/ttk_scale.n | 12 +++++------- doc/ttk_scrollbar.n | 12 +++++------- doc/ttk_separator.n | 4 ++-- doc/ttk_sizegrip.n | 4 ++-- doc/ttk_widget.n | 8 +++++++- 17 files changed, 62 insertions(+), 59 deletions(-) diff --git a/ChangeLog b/ChangeLog index 637c05d..39c1746 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2008-05-09 Pat Thoyts + + * doc/ttk_*: 'identify' widget command is on all ttk widgets. + 2008-05-04 Joe English * macosx/ttkMacOSAquaTheme.c: "default" and "focus" adornments diff --git a/doc/ttk_button.n b/doc/ttk_button.n index 66acf14..fca276b 100644 --- a/doc/ttk_button.n +++ b/doc/ttk_button.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_button.n,v 1.11 2008/01/29 15:38:00 dkf Exp $ +'\" RCS: @(#) $Id: ttk_button.n,v 1.12 2008/05/09 18:35:00 patthoyts Exp $ '\" .so man.macros .TH ttk::button n 8.5 Tk "Tk Themed Widget" @@ -56,18 +56,13 @@ in the style. .\" .OP \-padding padding Padding .\" .OP \-relief relief Relief .SH "WIDGET COMMAND" +In addition to the standard +\fBcget\fR, \fBconfigure\fR, \fBidentify\fR, \fBinstate\fR, and \fBstate\fR +commands, checkbuttons support the following additional +widget commands: .TP \fIpathName \fBinvoke\fR Invokes the command associated with the button. -.TP -\fIpathName \fBcget\fR \fIoption\fR -.TP -\fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? -.TP -\fIpathName \fBinstate \fIstateSpec\fR ?\fIscript\fR? -.TP -\fIpathName \fBstate\fR ?\fIstateSpec\fR? -See \fIttk::widget(n)\fR .SH "COMPATIBILITY OPTIONS" .OP \-state state State May be set to \fBnormal\fR or \fBdisabled\fR to control the diff --git a/doc/ttk_checkbutton.n b/doc/ttk_checkbutton.n index 5d717e0..90d4368 100644 --- a/doc/ttk_checkbutton.n +++ b/doc/ttk_checkbutton.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_checkbutton.n,v 1.12 2008/01/29 15:38:00 dkf Exp $ +'\" RCS: @(#) $Id: ttk_checkbutton.n,v 1.13 2008/05/09 18:35:00 patthoyts Exp $ '\" .so man.macros .TH ttk::checkbutton n 8.5 Tk "Tk Themed Widget" @@ -38,7 +38,7 @@ The name of a global variable whose value is linked to the widget. Defaults to the widget pathname if not specified. .SH "WIDGET COMMAND" In addition to the standard -\fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR +\fBcget\fR, \fBconfigure\fR, \fBidentify\fR, \fBinstate\fR, and \fBstate\fR commands, checkbuttons support the following additional widget commands: .TP diff --git a/doc/ttk_combobox.n b/doc/ttk_combobox.n index 9f3b83a..1a313c3 100644 --- a/doc/ttk_combobox.n +++ b/doc/ttk_combobox.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_combobox.n,v 1.15 2008/02/23 18:41:06 jenglish Exp $ +'\" RCS: @(#) $Id: ttk_combobox.n,v 1.16 2008/05/09 18:35:00 patthoyts Exp $ '\" .so man.macros .TH ttk::combobox n 8.5 Tk "Tk Themed Widget" @@ -74,8 +74,8 @@ Otherwise, returns the index of the current value in the list of Returns the current value of the combobox. .TP \fIpathName \fBidentify \fIx y\fR -Returns the name of the element at position \fIx\fR, \fIy\fR, -or the empty string if the coordinates are outside the window. +Returns the name of the element at position \fIx\fR, \fIy\fR. +See \fIttk::widget(n)\fR. .TP \fIpathName \fBinstate \fIstateSpec\fR ?\fIscript\fR? Test the widget state. diff --git a/doc/ttk_frame.n b/doc/ttk_frame.n index d51e1c3..370ebff 100644 --- a/doc/ttk_frame.n +++ b/doc/ttk_frame.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_frame.n,v 1.9 2008/01/29 15:38:00 dkf Exp $ +'\" RCS: @(#) $Id: ttk_frame.n,v 1.10 2008/05/09 18:35:00 patthoyts Exp $ '\" .so man.macros .TH ttk::frame n 8.5 Tk "Tk Themed Widget" @@ -37,7 +37,7 @@ If specified, the widget's requested width in pixels. If specified, the widget's requested height in pixels. .SH "WIDGET COMMAND" Supports the standard widget commands -\fBconfigure\fR, \fBcget\fR, \fBinstate\fR, and \fBstate\fR; +\fBconfigure\fR, \fBcget\fR, \fBidentify\fR, \fBinstate\fR, and \fBstate\fR; see \fIttk::widget(n)\fR. .SH "NOTES" Note that if the \fBpack\fR, \fBgrid\fR, or other geometry managers diff --git a/doc/ttk_label.n b/doc/ttk_label.n index f9bf6c6..419d7e4 100644 --- a/doc/ttk_label.n +++ b/doc/ttk_label.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_label.n,v 1.9 2008/01/29 15:38:00 dkf Exp $ +'\" RCS: @(#) $Id: ttk_label.n,v 1.10 2008/05/09 18:35:00 patthoyts Exp $ '\" .so man.macros .TH ttk::label n 8.5 Tk "Tk Themed Widget" @@ -68,14 +68,8 @@ then automatic wrapping is not performed; otherwise the text is split into lines such that no line is longer than the specified value. .SH "WIDGET COMMAND" -.TP -\fIpathName \fBcget\fR \fIoption\fR -.TP -\fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? -.TP -\fIpathName \fBinstate \fIstateSpec\fR ?\fIscript\fR? -.TP -\fIpathName \fBstate\fR ?\fIstateSpec\fR? -See \fIttk::widget(n)\fR +Supports the standard widget commands +\fBconfigure\fR, \fBcget\fR, \fBidentify\fR, \fBinstate\fR, and \fBstate\fR; +see \fIttk::widget(n)\fR. .SH "SEE ALSO" ttk::widget(n), label(n) diff --git a/doc/ttk_labelframe.n b/doc/ttk_labelframe.n index 5a302f9..243878d 100644 --- a/doc/ttk_labelframe.n +++ b/doc/ttk_labelframe.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_labelframe.n,v 1.9 2008/01/29 15:38:00 dkf Exp $ +'\" RCS: @(#) $Id: ttk_labelframe.n,v 1.10 2008/05/09 18:35:00 patthoyts Exp $ '\" .so man.macros .TH ttk::labelframe n 8.5 Tk "Tk Themed Widget" @@ -65,7 +65,7 @@ If specified, the widget's requested height in pixels. \fB\-height\fR). .SH "WIDGET COMMAND" Supports the standard widget commands -\fBconfigure\fR, \fBcget\fR, \fBinstate\fR, and \fBstate\fR; +\fBconfigure\fR, \fBcget\fR, \fBidentify\fR, \fBinstate\fR, and \fBstate\fR; see \fIttk::widget(n)\fR. .SH "SEE ALSO" ttk::widget(n), ttk::frame(n), labelframe(n) diff --git a/doc/ttk_menubutton.n b/doc/ttk_menubutton.n index 7999019..7a45da4 100644 --- a/doc/ttk_menubutton.n +++ b/doc/ttk_menubutton.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_menubutton.n,v 1.9 2008/01/29 15:38:00 dkf Exp $ +'\" RCS: @(#) $Id: ttk_menubutton.n,v 1.10 2008/05/09 18:35:00 patthoyts Exp $ '\" .so man.macros .TH ttk::menubutton n 8.5 Tk "Tk Themed Widget" @@ -39,7 +39,7 @@ menubutton. .\" .OP \-padding padding Pad .SH "WIDGET COMMAND" Menubutton widgets support the standard -\fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR +\fBcget\fR, \fBconfigure\fR, \fBidentify\fR, \fBinstate\fR, and \fBstate\fR methods. No other widget methods are used. .SH "SEE ALSO" ttk::widget(n), menu(n), menubutton(n) diff --git a/doc/ttk_notebook.n b/doc/ttk_notebook.n index 7d7e4d1..c407509 100644 --- a/doc/ttk_notebook.n +++ b/doc/ttk_notebook.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_notebook.n,v 1.12 2008/03/06 16:33:30 jenglish Exp $ +'\" RCS: @(#) $Id: ttk_notebook.n,v 1.13 2008/05/09 18:35:00 patthoyts Exp $ '\" .so man.macros .TH ttk::notebook n 8.5 Tk "Tk Themed Widget" @@ -124,6 +124,10 @@ The tab will not be displayed, but the associated window remains managed by the notebook and its configuration remembered. Hidden tabs may be restored with the \fBadd\fR command. .TP +\fIpathName \fBidentify\fR \fIx y\fR +Returns the name of the element at position \fIx\fR, \fIy\fR. +See \fIttk::widget(n)\fR. +.TP \fIpathname \fBindex\fR \fItabid\fR Returns the numeric index of the tab specified by \fItabid\fR, or the total number of tabs if \fItabid\fR is the string diff --git a/doc/ttk_panedwindow.n b/doc/ttk_panedwindow.n index a3cb277..18685cc 100644 --- a/doc/ttk_panedwindow.n +++ b/doc/ttk_panedwindow.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_panedwindow.n,v 1.15 2008/01/29 15:38:00 dkf Exp $ +'\" RCS: @(#) $Id: ttk_panedwindow.n,v 1.16 2008/05/09 18:35:00 patthoyts Exp $ '\" .so man.macros .TH ttk::panedwindow n 8.5 Tk "Tk Themed Widget" @@ -62,6 +62,10 @@ See \fBPANE OPTIONS\fR for the list of available options. Removes the specified subpane from the widget. \fIpane\fR is either an integer index or the name of a managed subwindow. .TP +\fIpathname\fR \fBidentify\fR \fIx y\fR +Returns the index of the sash at point \fIx,y\fR, +or the empty string if \fIx,y\fR is not over a sash. +.TP \fIpathname \fBinsert\fR \fIpos\fR \fIsubwindow\fR \fIoptions...\fR Inserts a pane at the specified position. \fIpos\fR is either the string \fBend\fR, an integer index, @@ -90,9 +94,5 @@ and the total size of the widget. .\" depending on which changed most recently. Returns the new position of sash number \fIindex\fR. .\" Full story: new position may be different than the requested position. -.TP -\fIpathname\fR \fBidentify\fR \fIx y\fR -Returns the index of the sash at point \fIx,y\fR, -or the empty string if \fIx,y\fR is not over a sash. .SH "SEE ALSO" ttk::widget(n), ttk::notebook(n), panedwindow(n) diff --git a/doc/ttk_progressbar.n b/doc/ttk_progressbar.n index 44be482..a91e098 100644 --- a/doc/ttk_progressbar.n +++ b/doc/ttk_progressbar.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_progressbar.n,v 1.10 2008/01/29 15:38:00 dkf Exp $ +'\" RCS: @(#) $Id: ttk_progressbar.n,v 1.11 2008/05/09 18:35:00 patthoyts Exp $ '\" .so man.macros .TH ttk::progressbar n 8.5 Tk "Tk Themed Widget" @@ -63,6 +63,10 @@ Returns the current value of the specified \fIoption\fR; see \fIttk::widget(n)\f \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? Modify or query widget options; see \fIttk::widget(n)\fR. .TP +\fIpathName \fBidentify\fR \fIx y\fR +Returns the name of the element at position \fIx\fR, \fIy\fR. +See \fIttk::widget(n)\fR. +.TP \fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? Test the widget state; see \fIttk::widget(n)\fR. .TP diff --git a/doc/ttk_radiobutton.n b/doc/ttk_radiobutton.n index 251577b..fe93e76 100644 --- a/doc/ttk_radiobutton.n +++ b/doc/ttk_radiobutton.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_radiobutton.n,v 1.11 2008/01/29 15:38:00 dkf Exp $ +'\" RCS: @(#) $Id: ttk_radiobutton.n,v 1.12 2008/05/09 18:35:00 patthoyts Exp $ '\" .so man.macros .TH ttk::radiobutton n 8.5 Tk "Tk Themed Widget" @@ -37,7 +37,7 @@ The name of a global variable whose value is linked to the widget. Default value is \fB::selectedButton\fR. .SH "WIDGET COMMAND" In addition to the standard -\fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR +\fBcget\fR, \fBconfigure\fR, \fBidentify\fR, \fBinstate\fR, and \fBstate\fR commands, radiobuttons support the following additional widget commands: .TP diff --git a/doc/ttk_scale.n b/doc/ttk_scale.n index 0806c36..c1a2b43 100644 --- a/doc/ttk_scale.n +++ b/doc/ttk_scale.n @@ -4,7 +4,7 @@ .\" See the file "license.terms" for information on usage and redistribution .\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. .\" -.\" CVS: @(#) $Id: ttk_scale.n,v 1.1 2008/02/06 14:34:57 dkf Exp $ +.\" CVS: @(#) $Id: ttk_scale.n,v 1.2 2008/05/09 18:35:00 patthoyts Exp $ .\" .so man.macros .TH ttk::scale n 8.5 Tk "Tk Themed Widget" @@ -65,6 +65,10 @@ Get the current value of the \fB\-value\fR option, or the value corresponding to the coordinates \fIx,y\fR if they are specified. \fIX\fR and \fIy\fR are pixel coordinates relative to the scale widget origin. .TP +\fIpathName \fBidentify\fR \fIx y\fR +Returns the name of the element at position \fIx\fR, \fIy\fR. +See \fIttk::widget(n)\fR. +.TP \fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? . Test the widget state; see \fIttk::widget(n)\fR. @@ -86,12 +90,6 @@ Modify or query the widget state; see \fIttk::widget(n)\fR. Get the coordinates corresponding to \fIvalue\fR, or the coordinates corresponding to the current value of the \fB\-value\fR option if \fIvalue\fR is omitted. -.TP -\fIpathName \fBidentify \fIx y\fR -. -Returns the name of the element under the point given by \fIx\fR and \fIy\fR, -or an empty string if the point does not lie in any element of the scale. -\fIX\fR and \fIy\fR are pixel coordinates relative to the scale widget origin. .SH "SEE ALSO" ttk::widget(n), scale(n) .SH KEYWORDS diff --git a/doc/ttk_scrollbar.n b/doc/ttk_scrollbar.n index d4128f8..5fa55f9 100644 --- a/doc/ttk_scrollbar.n +++ b/doc/ttk_scrollbar.n @@ -6,7 +6,7 @@ '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" '\" SOURCE: tk/doc/scrollbar.n, r1.4 -'\" RCS: @(#) $Id: ttk_scrollbar.n,v 1.12 2008/01/29 15:38:00 dkf Exp $ +'\" RCS: @(#) $Id: ttk_scrollbar.n,v 1.13 2008/05/09 18:35:00 patthoyts Exp $ '\" .so man.macros .TH ttk::scrollbar n 8.5 Tk "Tk Themed Widget" @@ -59,6 +59,10 @@ Modify or query widget options; see \fIttk::widget(n)\fR. Returns the scrollbar settings in the form of a list whose elements are the arguments to the most recent \fBset\fR widget command. .TP +\fIpathName \fBidentify\fR \fIx y\fR +Returns the name of the element at position \fIx\fR, \fIy\fR. +See \fIttk::widget(n)\fR. +.TP \fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR? Test the widget state; see \fIttk::widget(n)\fR. .TP @@ -94,12 +98,6 @@ and 1.0 corresponds to the bottom or right. widget. If \fIx\fR and \fIy\fR refer to a point outside the trough, the closest point in the trough is used. -.TP -\fIpathName \fBidentify\fR \fIx y\fR -Returns the name of the element under the point given -by \fIx\fR and \fIy\fR, or an empty string if the point does -not lie in any element of the scrollbar. -\fIX\fR and \fIy\fR are pixel coordinates relative to the scrollbar widget. .SH "SCROLLING COMMANDS" When the user interacts with the scrollbar, for example by dragging the thumb, the scrollbar notifies the associated widget that it diff --git a/doc/ttk_separator.n b/doc/ttk_separator.n index 87dfecb..ddfde59 100644 --- a/doc/ttk_separator.n +++ b/doc/ttk_separator.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_separator.n,v 1.8 2008/01/29 15:38:00 dkf Exp $ +'\" RCS: @(#) $Id: ttk_separator.n,v 1.9 2008/05/09 18:35:00 patthoyts Exp $ '\" .so man.macros .TH ttk::separator n 8.5 Tk "Tk Themed Widget" @@ -27,7 +27,7 @@ One of \fBhorizontal\fR or \fBvertical\fR. Specifies the orientation of the separator. .SH "WIDGET COMMAND" Separator widgets support the standard -\fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR +\fBcget\fR, \fBconfigure\fR, \fBidentify\fR, \fBinstate\fR, and \fBstate\fR methods. No other widget methods are used. .SH "SEE ALSO" ttk::widget(n) diff --git a/doc/ttk_sizegrip.n b/doc/ttk_sizegrip.n index d3ea7d9..308422a 100644 --- a/doc/ttk_sizegrip.n +++ b/doc/ttk_sizegrip.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_sizegrip.n,v 1.15 2008/01/29 15:38:00 dkf Exp $ +'\" RCS: @(#) $Id: ttk_sizegrip.n,v 1.16 2008/05/09 18:35:00 patthoyts Exp $ '\" .so man.macros .TH ttk::sizegrip n 8.5 Tk "Tk Themed Widget" @@ -24,7 +24,7 @@ by pressing and dragging the grip. .SE .SH "WIDGET COMMAND" Sizegrip widgets support the standard -\fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR +\fBcget\fR, \fBconfigure\fR, \fBidentify\fR, \fBinstate\fR, and \fBstate\fR methods. No other widget methods are used. .SH "PLATFORM-SPECIFIC NOTES" On Mac OSX, toplevel windows automatically include a built-in diff --git a/doc/ttk_widget.n b/doc/ttk_widget.n index 13af321..897cfbd 100644 --- a/doc/ttk_widget.n +++ b/doc/ttk_widget.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ttk_widget.n,v 1.13 2007/12/13 15:23:44 dgp Exp $ +'\" RCS: @(#) $Id: ttk_widget.n,v 1.14 2008/05/09 18:35:00 patthoyts Exp $ '\" .so man.macros .TH ttk::widget n 8.5 Tk "Tk Themed Widget" @@ -144,6 +144,12 @@ and current value. .\" Note: Ttk widgets don't use TK_OPTION_SYNONYM. If no \fIoption\fR is specified, returns a list describing all of the available options for \fIpathName\fR. +.TP +\fIpathName \fBidentify\fR \fIx y\fR +Returns the name of the element under the point given +by \fIx\fR and \fIy\fR, or an empty string if the point does +not lie within any element. +\fIx\fR and \fIy\fR are pixel coordinates relative to the widget. .TP \fIpathName \fBinstate\fR \fIstatespec\fR ?\fIscript\fR? Test the widget's state. -- cgit v0.12