URL
https://opencores.org/ocsvn/or1k/or1k/trunk
[/] [or1k/] [trunk/] [insight/] [tk/] [doc/] [GetOption.3] - Blame information for rev 1765
Details |
Compare with Previous |
View Log
Line No. |
Rev |
Author |
Line |
1 |
578 |
markom |
'\"
|
2 |
|
|
'\" Copyright (c) 1990 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: GetOption.3,v 1.1.1.1 2002-01-16 10:25:48 markom Exp $
|
9 |
|
|
'\"
|
10 |
|
|
.so man.macros
|
11 |
|
|
.TH Tk_GetOption 3 "" Tk "Tk Library Procedures"
|
12 |
|
|
.BS
|
13 |
|
|
.SH NAME
|
14 |
|
|
Tk_GetOption \- retrieve an option from the option database
|
15 |
|
|
.SH SYNOPSIS
|
16 |
|
|
.nf
|
17 |
|
|
\fB#include \fR
|
18 |
|
|
.sp
|
19 |
|
|
Tk_Uid
|
20 |
|
|
\fBTk_GetOption\fR(\fItkwin, name, class\fR)
|
21 |
|
|
.SH ARGUMENTS
|
22 |
|
|
.AS Tk_Window *class
|
23 |
|
|
.AP Tk_Window tkwin in
|
24 |
|
|
Token for window.
|
25 |
|
|
.AP char *name in
|
26 |
|
|
Name of desired option.
|
27 |
|
|
.AP char *class in
|
28 |
|
|
Class of desired option. Null means there is no class for
|
29 |
|
|
this option; do lookup based on name only.
|
30 |
|
|
.BE
|
31 |
|
|
|
32 |
|
|
.SH DESCRIPTION
|
33 |
|
|
.PP
|
34 |
|
|
This procedure is invoked to retrieve an option from the database
|
35 |
|
|
associated with \fItkwin\fR's main window. If there is an option
|
36 |
|
|
for \fItkwin\fR that matches the given \fIname\fR or \fIclass\fR,
|
37 |
|
|
then it is returned in the form of a Tk_Uid. If multiple options
|
38 |
|
|
match \fIname\fR and \fIclass\fR, then the highest-priority one
|
39 |
|
|
is returned. If no option matches, then NULL is returned.
|
40 |
|
|
.PP
|
41 |
|
|
\fBTk_GetOption\fR caches options related to \fItkwin\fR so that
|
42 |
|
|
successive calls for the same \fItkwin\fR will execute much more
|
43 |
|
|
quickly than successive calls for different windows.
|
44 |
|
|
|
45 |
|
|
.SH KEYWORDS
|
46 |
|
|
class, name, option, retrieve
|
© copyright 1999-2024
OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.