[Tcl-bugs] [Bug #120944] Documentation update: Tk_ConfigureWidget deprecation

[<no...@so...>]

Bug #120944, was updated on 2000-Oct-31 17:31
Here is a current snapshot of the bug.

Project: Tk Toolkit
Category: Docs
Status: Closed
Resolution: Fixed
Bug Group: 8.3.2
Priority: 7
Summary: Documentation update: Tk_ConfigureWidget deprecation

Details: OriginalBugID: 6176 Bug
Version: 8.3.2
SubmitDate: '2000-08-29'
LastModified: 
Severity: LOW
Status: UnAssn
Submitter: techsupp
OS: All


Name:
Joe English

CVS:
$Id: ConfigWidg.3,v 1.6 2000/07/25 21:14:34 jenglish Exp $

Comments:
Though I have write permission to the repository, I thought I'd go
    through the
    bug form instead so that the TCT can review the proposed wording.

ReproducibleScript:
N/A

ObservedBehavior:
Eric Melski recently mentioned on comp.lang.tcl that Tk_ConfigureWidget has been deprecated
in favor of the new Tcl_Obj-based API  (Tk_SetOptions and friends).
There is no mention of this in the ConfigWidget man page though.

DesiredBehavior:
A notice that Tk_ConfigureWidget is deprecated.  Suggested wording is below.

Patch:
Index: ConfigWidg.3
===================================================================
RCS file: /home/cvs/external/tk/doc/ConfigWidg.3,v
retrieving revision 1.6
diff -c -r1.6 ConfigWidg.3
*** ConfigWidg.3        2000/07/25 21:14:34     1.6
--- ConfigWidg.3        2000/08/28 23:16:33
***************
*** 66,72 ****
--- 66,78 ----
  order to free up resources.
  .BE
  .SH DESCRIPTION
+ .VS 8.1
  .PP
+ Note: \fBTk_ConfigureWidget\fP should be replaced 
+ with the new \fBTcl_Obj\fP based API \fBTk_SetOptions\fP.
+ The old interface is retained for backward compatibility.
+ .VE
+ .PP
  \fBTk_ConfigureWidget\fR is called to configure various aspects of a
  widget, such as colors, fonts, border width, etc.
  It is intended as a convenience procedure to reduce the amount
***************
*** 612,617 ****
--- 618,626 ----
  (tkFrame.c) has a simple configuration table, and the library
  implementation of buttons (tkButton.c) has a much more complex
  table that uses many of the fancy \fIspecFlags\fR mechanisms.
+ 
+ .SH "SEE ALSO"
+ Tk_SetOptions

  .SH KEYWORDS
  anchor, bitmap, boolean, border, cap style, color, configuration options,

PatchFiles:
tk/doc/ConfigWidg.3





For detailed info, follow this link:
http://sourceforge.net/bugs/?func=detailbug&bug_id=120944&group_id=12997