1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
|
# Copyright (c) 1990 The Regents of the University of California.
# Copyright (c) 1994-1996 Sun Microsystems, Inc.
# See the file "license.terms" for information on usage and redistribution
# of this file, and for a DISCLAIMER OF ALL WARRANTIES.
#
#
=head1 NAME
Tk_GetOption - retrieve an option from the option database
=for category C Programming
=head1 SYNOPSIS
B<#include E<lt>tk.hE<gt>>
Tk_Uid
B<Tk_GetOption>(I<tkwin, name, class>)
=head1 ARGUMENTS
=over 4
=item Tk_Window tkwin (in)
Token for window.
=item char *name (in)
Name of desired option.
=item char *class (in)
Class of desired option. Null means there is no class for
this option; do lookup based on name only.
=back
=head1 DESCRIPTION
This procedure is invoked to retrieve an option from the database
associated with I<tkwin>'s main window. If there is an option
for I<tkwin> that matches the given I<name> or I<class>,
then it is returned in the form of a Tk_Uid. If multiple options
match I<name> and I<class>, then the highest-priority one
is returned. If no option matches, then NULL is returned.
B<Tk_GetOption> caches options related to I<tkwin> so that
successive calls for the same I<tkwin> will execute much more
quickly than successive calls for different windows.
=head1 KEYWORDS
class, name, option, retrieve
|