.\" Copyright (C) 2001 Information-technology Promotion Agency (IPA)
.\" Copyright (C) 2001-2003
.\"   National Institute of Advanced Industrial Science and Technology (AIST)
.\" This file si aprt 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, Front-Cover Texts "The m17n library documentation",
.\" and no Back-Cover Texts.  A copy of the license is included in the
.\" appendix entitled "GNU Free Documentation License".
.TH "mframe_get_prop" 3m17n "14 Jul 2007" "" "Version 1.4.0" "" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mframe_get_prop - Return property value of frame. 


.SH SYNOPSIS
void*
\fBmframe_get_prop\fP (\fBMFrame\fP *
\fIframe\fP, \fBMSymbol\fP
\fIkey\fP)


.SH DESCRIPTION
The
.ft B
mframe_get_prop()
.ft R
function returns a value of property
.ft B
key
.ft R
of frame
.ft B
frame\fP.
.ft R
The valid keys and the corresponding return values are as follows.
.PP
.PP
.nf


        key             type of value   meaning of value
        ---             -------------   ----------------
        Mface           MFace *         The default face.

        Mfont           MFont *         The default font.

        Mfont_width     int             Width of the default font.

        Mfont_ascent    int             Ascent of the default font.

        Mfont_descent   int             Descent of the default font.

.fi
.fi
.PP
In the m17n-X library, the followings are also accepted.
.PP
.PP
.nf


        key             type of value   meaning of value
        ---             -------------   ----------------
        Mdisplay        Display *       Display associated with the frame.

        Mscreen         int             Screen number of a screen associated
                                        with the frame.

        Mcolormap       Colormap        Colormap of the frame.

        Mdepth          unsigned        Depth of the frame.
.fi
.fi