Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Tk_AddOption (3tk)

Name

Tk_AddOption - Add an option to the option database

Synopsis

#include <tk.h>

void
Tk_AddOption(tkwin, name, value, priority)

Description

Tk_AddOption(3tk)            Tk Library Procedures           Tk_AddOption(3tk)



______________________________________________________________________________

NAME
       Tk_AddOption - Add an option to the option database

SYNOPSIS
       #include <tk.h>

       void
       Tk_AddOption(tkwin, name, value, priority)

ARGUMENTS
       Tk_Window tkwin (in)                      Token for window.

       const char *name (in)                     Multi-element name of option.

       const char *value (in)                    Value of option.

       int priority (in)                         Overall priority level to use
                                                 for option.
______________________________________________________________________________

DESCRIPTION
       This procedure is invoked to add an option to the  database  associated
       with tkwin's main window.  Name contains the option being specified and
       consists of names and/or classes separated by asterisks or dots, in the
       usual X format.  Value contains the text string to associate with name;
       this value will be returned in calls to Tk_GetOption.  Priority  speci-
       fies  the  priority  of  the  value;  when  options  are  queried using
       Tk_GetOption, the value with the highest priority is returned.   Prior-
       ity  must  be  between  0 and TK_MAX_PRIO.  Some common priority values
       are:

       20     Used for default values hard-coded into widgets.

       40     Used  for  options  specified  in  application-specific  startup
              files.

       60     Used for options specified in user-specific defaults files, such
              as .Xdefaults, resource databases loaded into the X  server,  or
              user-specific startup files.

       80     Used  for  options specified interactively after the application
              starts running.

KEYWORDS
       class, name, option, add



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | runtime/tk-8     |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source        was        downloaded        from         https://source-
       forge.net/projects/tcl/files/Tcl/8.6.7/tk8.6.7-src.tar.gz/download.

       Further information about this software can be found on the open source
       community website at https://www.tcl.tk/.



Tk                                                           Tk_AddOption(3tk)