Author: junrue Date: Thu Oct 19 02:50:57 2006 New Revision: 355
Modified: trunk/docs/manual/catalog.xml trunk/docs/manual/gf-data.xsl trunk/docs/manual/gfg-symbols.xml trunk/docs/manual/win32-api-table.xml Log:
Modified: trunk/docs/manual/catalog.xml ============================================================================== --- trunk/docs/manual/catalog.xml (original) +++ trunk/docs/manual/catalog.xml Thu Oct 19 02:50:57 2006 @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!-- - graphic-forms.xsl + catalog.xml
Copyright (c) 2006, Jack D. Unrue -->
Modified: trunk/docs/manual/gf-data.xsl ============================================================================== --- trunk/docs/manual/gf-data.xsl (original) +++ trunk/docs/manual/gf-data.xsl Thu Oct 19 02:50:57 2006 @@ -211,6 +211,19 @@ </xsl:call-template> </xsl:template>
+ <xsl:template match="enum"> + <xsl:for-each select="argument"> + <xsl:element name="indexterm"> + <xsl:element name="primary"> + <xsl:value-of select="@name"/> + </xsl:element> + </xsl:element> + </xsl:for-each> + <xsl:call-template name="emit-table"> + <xsl:with-param name="col2-width">5*</xsl:with-param> + </xsl:call-template> + </xsl:template> + <xsl:template match="inherits"> <xsl:element name="row"> <xsl:element name="entry"> @@ -365,6 +378,12 @@ </xsl:call-template> </xsl:template>
+ <xsl:template match="macro"> + <xsl:call-template name="emit-function-section"> + <xsl:with-param name="page-type">Macro</xsl:with-param> + </xsl:call-template> + </xsl:template> + <xsl:template match="/package"> <data> xsl:apply-templates
Modified: trunk/docs/manual/gfg-symbols.xml ============================================================================== --- trunk/docs/manual/gfg-symbols.xml (original) +++ trunk/docs/manual/gfg-symbols.xml Thu Oct 19 02:50:57 2006 @@ -323,6 +323,300 @@
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="metrics"> + <syntax> + <arguments> + <argument name="context"> + <description> + The context for retrieving the metrics of <refargument>font</refargument>. + </description> + </argument> + <argument name="font"> + <description> + A <reftopic>gfg:font</reftopic> object. + </description> + </argument> + </arguments> + <return> + <reftopic>gfg:font-metrics</reftopic> + </return> + </syntax> + <description> + Returns a <reftopic>gfg:font-metrics</reftopic> object describing + attributes of <refargument>font</refargument>. + </description> + <seealso> + <reftopic>gfg:text-extent</reftopic> + </seealso> + </generic-function> + + <generic-function name="text-extent"> + <syntax> + <arguments> + <argument name="context"> + <description> + The context for measuring the extent of <refargument>string</refargument>. + </description> + </argument> + <argument name="string &optional"> + <description> + The <refclhs>string</refclhs> whose pixel dimensions are to be computed. + </description> + </argument> + <argument name="style"> + <description> + A <refclhs>list</refclhs> containing zero or more of the following + keyword symbols: + <enum> + <argument name=":mnemonic"> + <description> + Underline the mnemonic character if any (preceded in + <refargument>string</refargument> with an ampersand). + </description> + </argument> + <argument name=":tab"> + <description> + Expand tabs when <refargument>string</refargument> is rendered; + by default the tab width is 8 characters. + </description> + </argument> + </enum> + </description> + </argument> + <argument name="tab-width"> + <description> + An <refclhs>integer</refclhs> specifying a custom tab width; only + meaningful if the :tab style keyword is supplied. + </description> + </argument> + </arguments> + <return> + <reftopic>gfs:size</reftopic> + </return> + </syntax> + <description> + Returns the size of a rectangular region that would enclose + <refargument>string</refargument> if it were drawn. These dimensions + are dependent on the <reftopic>gfg:font</reftopic> currently selected + in <refargument>context</refargument>. + </description> + <seealso> + <reftopic>gfg:font-metrics</reftopic> + </seealso> + </generic-function> + <!-- ACCESSORS -->
+ <!-- MACROS --> + + <macro name="color->rgb"> + <syntax> + <arguments> + <argument name="color"> + <description> + A <reftopic>gfg:color</reftopic> to be converted to the Win32 + <refwin32api>COLORREF</refwin32api> representation. + </description> + </argument> + </arguments> + <return> + <refwin32api>COLORREF</refwin32api> + </return> + </syntax> + <description> + This macro converts a <reftopic>gfg:color</reftopic> to the Win32 + <refwin32api>COLORREF</refwin32api> representation, which in CFFI + terms is defined as an alias for the :unsigned-long type. + </description> + <seealso> + <reftopic>gfg:rgb->color</reftopic> + </seealso> + </macro> + + <macro name="rgb->color"> + <syntax> + <arguments> + <argument name="COLOREF"> + <description> + A Win32 <refwin32api>COLORREF</refwin32api> value to be translated + to a <reftopic>gfg:color</reftopic> object. + </description> + </argument> + </arguments> + <return> + <reftopic>gfg:color</reftopic> + </return> + </syntax> + <description> + This macro converts a Win32 <refwin32api>COLORREF</refwin32api> value, + which in CFFI terms is defined as an alias for :unsigned-long, to a + <reftopic>gfg:color</reftopic>. + </description> + <seealso> + <reftopic>gfg:color->rgb</reftopic> + </seealso> + </macro> + + <macro name="ascent"> + <syntax> + <arguments> + <argument name="font-metrics"> + <description> + The <reftopic>gfg:font-metrics</reftopic> object whose ascent value + is to be queried. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + This macro returns the ascent value for a <reftopic>gfg:font</reftopic>, + which is the number of units above the character base line. + </description> + <seealso> + <reftopic>gfg:average-char-width</reftopic> + <reftopic>gfg:descent</reftopic> + <reftopic>gfg:height</reftopic> + <reftopic>gfg:leading</reftopic> + <reftopic>gfg:maximum-char-width</reftopic> + </seealso> + </macro> + + <macro name="average-char-width"> + <syntax> + <arguments> + <argument name="font-metrics"> + <description> + The <reftopic>gfg:font-metrics</reftopic> object whose average + character width is to be queried. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + This macro returns the average width of a character in a + <reftopic>gfg:font</reftopic>. + </description> + <seealso> + <reftopic>gfg:ascent</reftopic> + <reftopic>gfg:descent</reftopic> + <reftopic>gfg:height</reftopic> + <reftopic>gfg:leading</reftopic> + <reftopic>gfg:maximum-char-width</reftopic> + </seealso> + </macro> + + <macro name="descent"> + <syntax> + <arguments> + <argument name="font-metrics"> + <description> + The <reftopic>gfg:font-metrics</reftopic> object whose descent value + is to be queried. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + This macro returns the descent value for a <reftopic>gfg:font</reftopic>, + which is the number of units above the character base line. + </description> + <seealso> + <reftopic>gfg:average-char-width</reftopic> + <reftopic>gfg:ascent</reftopic> + <reftopic>gfg:height</reftopic> + <reftopic>gfg:leading</reftopic> + <reftopic>gfg:maximum-char-width</reftopic> + </seealso> + </macro> + + <macro name="height"> + <syntax> + <arguments> + <argument name="font-metrics"> + <description> + The <reftopic>gfg:font-metrics</reftopic> object whose height value + is to be queried. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + This macro returns the height value for a <reftopic>gfg:font</reftopic>, + which is the sum of the font's ascent and descent. + </description> + <seealso> + <reftopic>gfg:ascent</reftopic> + <reftopic>gfg:average-char-width</reftopic> + <reftopic>gfg:descent</reftopic> + <reftopic>gfg:leading</reftopic> + <reftopic>gfg:maximum-char-width</reftopic> + </seealso> + </macro> + + <macro name="leading"> + <syntax> + <arguments> + <argument name="font-metrics"> + <description> + The <reftopic>gfg:font-metrics</reftopic> object whose leading value + is to be queried. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + This macro returns the leading value for a <reftopic>gfg:font</reftopic>, + which is the amount of extra space added between rows of text. + </description> + <seealso> + <reftopic>gfg:ascent</reftopic> + <reftopic>gfg:average-char-width</reftopic> + <reftopic>gfg:descent</reftopic> + <reftopic>gfg:height</reftopic> + <reftopic>gfg:maximum-char-width</reftopic> + </seealso> + </macro> + + <macro name="maximum-char-width"> + <syntax> + <arguments> + <argument name="font-metrics"> + <description> + The <reftopic>gfg:font-metrics</reftopic> object whose maximum + character width is to be queried. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + This macro returns the maximum width of a character in a + <reftopic>gfg:font</reftopic>. + </description> + <seealso> + <reftopic>gfg:ascent</reftopic> + <reftopic>gfg:descent</reftopic> + <reftopic>gfg:height</reftopic> + <reftopic>gfg:leading</reftopic> + <reftopic>gfg:average-char-width</reftopic> + </seealso> + </macro> + </package>
Modified: trunk/docs/manual/win32-api-table.xml ============================================================================== --- trunk/docs/manual/win32-api-table.xml (original) +++ trunk/docs/manual/win32-api-table.xml Thu Oct 19 02:50:57 2006 @@ -6,6 +6,7 @@ -->
<win32-api-table> + <entry name="COLORREF" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/gdi/colors_9xiq.asp"/> <entry name="CommDlgExtendedError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/winui/windowsuserinterface/userinput/commondialogboxlibrary/commondialogboxreference/commondialogboxfunctions/commdlgextendederror.asp"/> <entry name="GetLastError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base/getlasterror.asp"/> <entry name="Icons in Win32" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnwui/html/msdn_icons.asp"/>