Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > by-pkgid > 2fc07611b08d4a735fd34d5eb60d8e16 > files > 2089

ciao-1.10p8-3mdv2010.0.i586.rpm

<HTML>
<HEAD>
<!-- Created by texi2html 1.56k + clip patches and <A href="http://www.clip.dia.fi.upm.es/Software">lpdoc</A> from ciao.texi on 28 January 2007 -->

<LINK rel="stylesheet" href="ciao.css" type="text/css">
<TITLE>The Ciao Prolog System               - text_class (library)</TITLE>
</HEAD>
<BODY> 
Go to the <A HREF="ciao_1.html">first</A>, <A HREF="ciao_142.html">previous</A>, <A HREF="ciao_144.html">next</A>, <A HREF="ciao_241.html">last</A> section, <A HREF="ciao_toc.html">table of contents</A>.
<P><HR><P>


<H1><A NAME="SEC593" HREF="ciao_toc.html#TOC593">text_class (library)</A></H1>
<P>
<A NAME="IDX6535"></A>


<P>
<STRONG>Author(s):</STRONG> Montserrat Urraca.


<P>
<STRONG>Version:</STRONG> 1.10#7 (2006/4/26, 19:22:13 CEST)


<P>
<STRONG>Version of last change:</STRONG> 1.9#148 (2003/12/4, 17:34:58 CET)



<UL>
<LI><A HREF="ciao_143.html#SEC594">Usage and interface (text_class)</A>
<LI><A HREF="ciao_143.html#SEC595">Documentation on exports (text_class)</A>
</UL>



<H2><A NAME="SEC594" HREF="ciao_toc.html#TOC594">Usage and interface (<CODE>text_class</CODE>)</A></H2>

<div class="cartouche">

<UL>

<LI><STRONG>Library usage:</STRONG>

<CODE>:- use_module(library(text_class)).</CODE>

<LI><STRONG>Exports:</STRONG>


<UL>

<LI><EM>Predicates:</EM>

<A NAME="IDX6536"></A>
<CODE>coord/2</CODE>, 
<A NAME="IDX6537"></A>
<CODE>point/2</CODE>, 
<A NAME="IDX6538"></A>
<CODE>text_characters/1</CODE>, 
<A NAME="IDX6539"></A>
<CODE>anchor/1</CODE>, 
<A NAME="IDX6540"></A>
<CODE>font_type/1</CODE>, 
<A NAME="IDX6541"></A>
<CODE>justify_text/1</CODE>.

</UL>

<LI><STRONG>Other modules used:</STRONG>


<UL>

<LI><EM>System library modules:</EM>

<A NAME="IDX6542"></A>
<CODE>objects/objects_rt</CODE>.

</UL>

</UL>

</div class="cartouche">



<H2><A NAME="SEC595" HREF="ciao_toc.html#TOC595">Documentation on exports (<CODE>text_class</CODE>)</A></H2>
<P>
<A NAME="IDX6543"></A>
<A NAME="IDX6544"></A>
<DL>
<DT><span class="define">PREDICATE:</span> <B>coord/2:</B>
<DD><A NAME="IDX6545"></A>


<P>
<STRONG>Usage:</STRONG> <CODE>coord(+X, +Y)</CODE>

<UL>
<LI><EM>Description:</EM> <CODE>X</CODE> and <CODE>Y</CODE> specify the coordinates of a point used to position the text on the display.

<LI><EM>Call and exit should be <EM>compatible</EM> with:</EM>

<CODE>+X</CODE> is an integer.
 (<CODE>basic_props:int/1</CODE>)

<CODE>+Y</CODE> is an integer.
 (<CODE>basic_props:int/1</CODE>)
</UL>

</DL>

<P>
<A NAME="IDX6546"></A>
<A NAME="IDX6547"></A>
<DL>
<DT><span class="define">PREDICATE:</span> <B>point/2:</B>
<DD><A NAME="IDX6548"></A>


<P>
<STRONG>Usage:</STRONG> <CODE>point(+X, +Y)</CODE>

<UL>
<LI><EM>Description:</EM> <CODE>X</CODE> and <CODE>Y</CODE> change the coordinates of a point used to position the text on the display.

<LI><EM>Call and exit should be <EM>compatible</EM> with:</EM>

<CODE>+X</CODE> is an integer.
 (<CODE>basic_props:int/1</CODE>)

<CODE>+Y</CODE> is an integer.
 (<CODE>basic_props:int/1</CODE>)
</UL>

</DL>

<P>
<A NAME="IDX6549"></A>
<A NAME="IDX6550"></A>
<DL>
<DT><span class="define">PREDICATE:</span> <B>text_characters/1:</B>
<DD><A NAME="IDX6551"></A>


<P>
<STRONG>Usage 1:</STRONG> <CODE>text_characters(+Text)</CODE>

<UL>
<LI><EM>Description:</EM> <CODE>Text</CODE> specifies the characters to be displayed in the text item. This option defaults to an empty string.

<LI><EM>Call and exit should be <EM>compatible</EM> with:</EM>

<CODE>+Text</CODE> is currently instantiated to an atom.
 (<CODE>term_typing:atom/1</CODE>)
</UL>

<P>
<STRONG>Usage 2:</STRONG> <CODE>text_characters(-Text)</CODE>

<UL>
<LI><EM>Description:</EM> Gets the text displayed in the text item.

<LI><EM>Call and exit should be <EM>compatible</EM> with:</EM>

<CODE>-Text</CODE> is currently instantiated to an atom.
 (<CODE>term_typing:atom/1</CODE>)
</UL>

</DL>

<P>
<A NAME="IDX6552"></A>
<A NAME="IDX6553"></A>
<DL>
<DT><span class="define">PREDICATE:</span> <B>anchor/1:</B>
<DD><A NAME="IDX6554"></A>


<P>
<STRONG>Usage 1:</STRONG> <CODE>anchor(+AnchorPos)</CODE>

<UL>
<LI><EM>Description:</EM> <CODE>AnchorPos</CODE> tells how to position the text relative to the positioning point for the text. This option defaluts to center.

<LI><EM>Call and exit should be <EM>compatible</EM> with:</EM>

<CODE>+AnchorPos</CODE> is currently instantiated to an atom.
 (<CODE>term_typing:atom/1</CODE>)
</UL>

<P>
<STRONG>Usage 2:</STRONG> <CODE>anchor(-AnchorPos)</CODE>

<UL>
<LI><EM>Description:</EM> Gets the position of the text relative to the positioning point.

<LI><EM>Call and exit should be <EM>compatible</EM> with:</EM>

<CODE>-AnchorPos</CODE> is currently instantiated to an atom.
 (<CODE>term_typing:atom/1</CODE>)
</UL>

</DL>

<P>
<A NAME="IDX6555"></A>
<A NAME="IDX6556"></A>
<DL>
<DT><span class="define">PREDICATE:</span> <B>font_type/1:</B>
<DD><A NAME="IDX6557"></A>


<P>
<STRONG>Usage 1:</STRONG> <CODE>font_type(+Font)</CODE>

<UL>
<LI><EM>Description:</EM> <CODE>Font</CODE> specifies the font to use for the text item. This option defaluts to arial.

<LI><EM>Call and exit should be <EM>compatible</EM> with:</EM>

<CODE>+Font</CODE> is currently instantiated to an atom.
 (<CODE>term_typing:atom/1</CODE>)
</UL>

<P>
<STRONG>Usage 2:</STRONG> <CODE>font_type(-Font)</CODE>

<UL>
<LI><EM>Description:</EM> Gets the value of the <CODE>Font</CODE> used for the text item.

<LI><EM>Call and exit should be <EM>compatible</EM> with:</EM>

<CODE>-Font</CODE> is currently instantiated to an atom.
 (<CODE>term_typing:atom/1</CODE>)
</UL>

</DL>

<P>
<A NAME="IDX6558"></A>
<A NAME="IDX6559"></A>
<DL>
<DT><span class="define">PREDICATE:</span> <B>justify_text/1:</B>
<DD><A NAME="IDX6560"></A>


<P>
<STRONG>Usage 1:</STRONG> <CODE>justify_text(+How)</CODE>

<UL>
<LI><EM>Description:</EM> <CODE>How</CODE> specifies how to justify the text within its bounding region. <CODE>How</CODE> must be one of the values left, right or center. This option defaluts to left.

<LI><EM>Call and exit should be <EM>compatible</EM> with:</EM>

<CODE>+How</CODE> is currently instantiated to an atom.
 (<CODE>term_typing:atom/1</CODE>)
</UL>

<P>
<STRONG>Usage 2:</STRONG> <CODE>justify_text(-How)</CODE>

<UL>
<LI><EM>Description:</EM> Gets <CODE>How</CODE> is justified the text.

<LI><EM>Call and exit should be <EM>compatible</EM> with:</EM>

<CODE>-How</CODE> is currently instantiated to an atom.
 (<CODE>term_typing:atom/1</CODE>)
</UL>

</DL>

<P><HR><P>
Go to the <A HREF="ciao_1.html">first</A>, <A HREF="ciao_142.html">previous</A>, <A HREF="ciao_144.html">next</A>, <A HREF="ciao_241.html">last</A> section, <A HREF="ciao_toc.html">table of contents</A>.
</BODY>
</HTML>