aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authormertz2003-09-15 16:17:06 +0000
committermertz2003-09-15 16:17:06 +0000
commit8b34baa437e87479674b6ae723ea33b7423bb374 (patch)
tree49354bcfe24daf3ceef869ea65adc29795e49128 /doc
parent82bbdccfb51dbabc48ffde029058bd9aa68c24c8 (diff)
downloadtkzinc-8b34baa437e87479674b6ae723ea33b7423bb374.zip
tkzinc-8b34baa437e87479674b6ae723ea33b7423bb374.tar.gz
tkzinc-8b34baa437e87479674b6ae723ea33b7423bb374.tar.bz2
tkzinc-8b34baa437e87479674b6ae723ea33b7423bb374.tar.xz
perl modules ZincTrace ZincTraceErrors and ZincDebug have been renamed
Tk::Zinc::Trace Tk::Zinc::TraceErrors and Tk::Zinc::debug and moved accordingly
Diffstat (limited to 'doc')
-rw-r--r--doc/refman.tex26
1 files changed, 14 insertions, 12 deletions
diff --git a/doc/refman.tex b/doc/refman.tex
index 701fe16..4d6a02c 100644
--- a/doc/refman.tex
+++ b/doc/refman.tex
@@ -313,6 +313,8 @@ It has been replaced by the GLU library. So TkZinc is again fully free software.
\item the syntax of gradient has been changed, mainly to accomodate with any color specification
defined for X. {\bf Beware that old gradient are no more compatible}
\item conical gradient type has been added; gradient paramaters has been extended.
+\item Perl modules ZincDebug, ZincTrace and ZincTraceErrors have been renamed Tk::Zinc::Debug
+Tk::Zinc::Trace and Tk::Zinc::Trace.
\item TkZinc comes now with a ZincTrace.pm module to trace every TkZinc method call
\item the hierarchical view in ZincDebug.pm can now display some choosen attributes
in a choosen format.
@@ -4573,26 +4575,26 @@ named AlphaStipple0 to AlphaStipple15, AlphaStipple0 being the most transparent.
-\section{ZincDebug.pm}
+\section{Tk::Zinc::Debug.pm}
-\ident{ZincDebug.pm} is a Perl module useful for debugging purpose. It can be used in a
+\ident{Tk::Zinc::Debug.pm} is a Perl module useful for debugging purpose. It can be used in a
Perl application using TkZinc to display the hierarchical tree of items, to display
items selected by their id or tags, to grab items with the mouse and to get the list of
items enclosed or overlapped by a rectangle designated by the mouse. You will be
presented a list of items, with many interesting attributes such as position, priority,
visibility, group...\ and even more information on request. Much of the selected items
attributes can be interactively modified. When an application uses
-\ident{ZincDebug.pm}, you can get a short reminder by depressing the {\tt Esc} key in
+\ident{Tk::Zinc::Debug.pm}, you can get a short reminder by depressing the {\tt Esc} key in
the main window of this application. For more information, please refer to the
-\ident{ZincDebug.pm} man pages with the classical command {\tt man ZincDebug}
+\ident{Tk::Zinc::Debug.pm} man pages with the classical command {\tt man Tk::Zinc::Debug}
To use this module, you can import it either by adding, for example, the following
statements in your source code:
-\code{\\use ZincDebug;\\
+\code{\\use Tk::Zinc::Debug;\\
finditems(\$zinc);\\
tree(\$zinc, -optionsToDisplay => '-tags', -optionsFormat => 'row');\\}
or simply by using the -M option of Perl:
-\code{\\perl -MZincDebug yourscript.pl\\}
+\code{\\perl -MTk::Zinc::Debug yourscript.pl\\}
\section{Tracing TkZinc methods call in Perl/Tk}
@@ -4605,7 +4607,7 @@ or tracking some nasty segfault which should never occure since TkZinc is
Because you sometime get some errors inside \ident{TkZinc} with a cryptic message
like {\tt ".... errors in Tk.pm line 228"}, it may be usefull to know where exactly
in your code is the error. There is a simple and convenient mean to do this, just
-by using a small module called \ident{ZincTraceErrors.pm}, released with \ident{TkZinc}.
+by using a small module called \ident{Tk::Zinc::TraceErrors}, released with \ident{TkZinc}.
It traces every call of a TkZinc method inducing a Tk error. It prints on
the standard output the following informations:
\begin{itemize}
@@ -4618,14 +4620,14 @@ the standard output the following informations:
To use this module you can import it either by adding the following
statement in your source code:
-\code{\\use ZincTraceErrors;\\} or better, by using the -M option of Perl:
-\code{\\perl -MZincTraceErrors yourscript.pl\\}
+\code{\\use Tk::Zinc::TraceErrors;\\} or better, by using the -M option of Perl:
+\code{\\perl -MTk::Zinc::TraceErrors yourscript.pl\\}
\subsection{Tracking TkZinc segfaults in Perl/Tk}
If you encounters a segfault in one Perl/Tk script and you suspects
that TkZinc might be responsible, you should use a small module called
-\ident{ZincTraceErrors.pm}, released with \ident{TkZinc}.
+\ident{Tk::Zinc::Trace}, released with \ident{TkZinc}.
It traces every call of a TkZinc method. The method call is printed
on the standard output before the effective call, and the
result of the invokation is printed after the call. To be sure
@@ -4643,8 +4645,8 @@ It prints on the standard output the following informations:
To use this module you can import it either by adding the following
statement in your source code:
-\code{\\use ZincTrace;\\} or better, by using the -M option of Perl:
-\code{\\perl -MZincTrace yourscript.pl\\}
+\code{\\use Tk::Zinc::Trace;\\} or better, by using the -M option of Perl:
+\code{\\perl -MTk::Zinc::Trace yourscript.pl\\}
\section{zinc-demos}