.\" Copyright (C) 2001 Information-technology Promotion Agency (IPA) .\" Copyright (C) 2001-2011 .\" National Institute of Advanced Industrial Science and Technology (AIST) .\" This file is part of the m17n library documentation. .\" Permission is granted to copy, distribute and/or modify this document .\" under the terms of the GNU Free Documentation License, Version 1.2 or .\" any later version published by the Free Software Foundation; with no .\" Invariant Section, no Front-Cover Texts, .\" and no Back-Cover Texts. A copy of the license is included in the .\" appendix entitled "GNU Free Documentation License". .TH "m17nFrame" 3m17n "Mon Sep 25 2023" "Version 1.8.4" "The m17n Library" \" -*- nroff -*- .ad l .nh .SH NAME m17nFrame_\-_F \- \- A \fIframe\fP is an object corresponding to the graphic device\&. .SH SYNOPSIS .br .PP .SS "Functions" .in +1c .ti -1c .RI "\fBMFrame\fP * \fBmframe\fP (\fBMPlist\fP *plist)" .br .RI "Create a new frame\&. " .ti -1c .RI "void * \fBmframe_get_prop\fP (\fBMFrame\fP *frame, MSymbol key)" .br .in -1c .SS "Variables" .in +1c .ti -1c .RI "\fBMFrame\fP * \fBmframe_default\fP" .br .RI "The default frame\&. " .in -1c .SS "Variables: Keys of frame parameter" These are the symbols to use in a parameter to create a frame\&. See the function \fBmframe()\fP for details\&. .PP \fBMdevice\fP, \fBMdisplay\fP, \fBMscreen\fP, \fBMdrawable\fP, \fBMdepth\fP, and \fBMcolormap\fP are also keys of a frame property\&. .br .in +1c .ti -1c .RI "MSymbol \fBMdevice\fP" .br .ti -1c .RI "MSymbol \fBMdisplay\fP" .br .ti -1c .RI "MSymbol \fBMscreen\fP" .br .ti -1c .RI "MSymbol \fBMdrawable\fP" .br .ti -1c .RI "MSymbol \fBMdepth\fP" .br .ti -1c .RI "MSymbol \fBMcolormap\fP" .br .ti -1c .RI "MSymbol \fBMwidget\fP" .br .ti -1c .RI "MSymbol \fBMgd\fP" .br .in -1c .SS "Variables: Keys of frame property" These are the symbols to use as an argument to the function \fBmframe_get_prop()\fP\&. .br .in +1c .ti -1c .RI "MSymbol \fBMfont\fP" .br .ti -1c .RI "MSymbol \fBMfont_width\fP" .br .ti -1c .RI "MSymbol \fBMfont_ascent\fP" .br .ti -1c .RI "MSymbol \fBMfont_descent\fP" .br .in -1c .SH "Detailed Description" .PP A \fIframe\fP is an object corresponding to the graphic device\&. A \fIframe\fP is an object of the type \fBMFrame\fP to hold various information about each display/input device\&. Almost all m17n GUI functions require a pointer to a frame as an argument\&. .br .SH "Variable Documentation" .PP .SS "MSymbol Mdevice" .SS "MSymbol Mdisplay" .SS "MSymbol Mscreen" .SS "MSymbol Mdrawable" .SS "MSymbol Mdepth" .SS "MSymbol Mcolormap" .SS "MSymbol Mwidget" .SS "MSymbol Mgd" .SS "MSymbol Mfont" .SS "MSymbol Mfont_width" .SS "MSymbol Mfont_ascent" .SS "MSymbol Mfont_descent" .SS "\fBMFrame\fP* mframe_default" .PP The default frame\&. The external variable \fBmframe_default\fP contains a pointer to the default frame that is created by the first call of \fBmframe()\fP\&. .br .SH "Author" .PP Generated automatically by Doxygen for The m17n Library from the source code\&. .SH COPYRIGHT Copyright (C) 2001 Information\-technology Promotion Agency (IPA) .br Copyright (C) 2001\-2011 National Institute of Advanced Industrial Science and Technology (AIST) .br Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License .