Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Tk_SetClass (3tk)

Name

Tk_SetClass - set or retrieve a window's class

Synopsis

#include <tk.h>

Tk_SetClass(tkwin, class)

Tk_Uid
Tk_Class(tkwin)

Description

Tk_SetClass(3tk)             Tk Library Procedures            Tk_SetClass(3tk)



______________________________________________________________________________

NAME
       Tk_SetClass, Tk_Class - set or retrieve a window's class

SYNOPSIS
       #include <tk.h>

       Tk_SetClass(tkwin, class)

       Tk_Uid
       Tk_Class(tkwin)

ARGUMENTS
       Tk_Window tkwin (in)           Token for window.

       char *class (in)               New class name for window.
______________________________________________________________________________

DESCRIPTION
       Tk_SetClass  is  called  to associate a class with a particular window.
       The class string identifies the type of the window;  all  windows  with
       the same general class of behavior (button, menu, etc.) should have the
       same class.  By convention all class names start with a capital letter,
       and there exists a Tcl command with the same name as each class (except
       all in lower-case) which can be used to create and  manipulate  windows
       of that class.  A window's class string is initialized to NULL when the
       window is created.

       For main windows, Tk automatically propagates the name and class to the
       WM_CLASS  property used by window managers.  This happens either when a
       main window is actually created (e.g. in Tk_MakeWindowExist),  or  when
       Tk_SetClass  is  called,  whichever occurs later.  If a main window has
       not been assigned a class then Tk will not set  the  WM_CLASS  property
       for the window.

       Tk_Class  is  a  macro that returns the current value of tkwin's class.
       The value is returned as a Tk_Uid, which may be used just like a string
       pointer  but  also  has  the properties of a unique identifier (see the
       manual entry for Tk_GetUid for details).  If tkwin  has  not  yet  been
       given a class, then Tk_Class will return NULL.

KEYWORDS
       class, unique identifier, window, window manager



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_SetClass(3tk)