<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 - menu_class (library)</TITLE> </HEAD> <BODY> Go to the <A HREF="ciao_1.html">first</A>, <A HREF="ciao_128.html">previous</A>, <A HREF="ciao_130.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="SEC551" HREF="ciao_toc.html#TOC551">menu_class (library)</A></H1> <P> <A NAME="IDX6293"></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#133 (2003/12/4, 17:33:46 CET) <UL> <LI><A HREF="ciao_129.html#SEC552">Usage and interface (menu_class)</A> <LI><A HREF="ciao_129.html#SEC553">Documentation on exports (menu_class)</A> </UL> <H2><A NAME="SEC552" HREF="ciao_toc.html#TOC552">Usage and interface (<CODE>menu_class</CODE>)</A></H2> <div class="cartouche"> <UL> <LI><STRONG>Library usage:</STRONG> <CODE>:- use_module(library(menu_class)).</CODE> <LI><STRONG>Exports:</STRONG> <UL> <LI><EM>Predicates:</EM> <A NAME="IDX6294"></A> <CODE>name_menu/1</CODE>, <A NAME="IDX6295"></A> <CODE>menu_data/1</CODE>, <A NAME="IDX6296"></A> <CODE>label_value/1</CODE>, <A NAME="IDX6297"></A> <CODE>tearoff_value/1</CODE>, <A NAME="IDX6298"></A> <CODE>tcl_name/1</CODE>, <A NAME="IDX6299"></A> <CODE>creation_options/1</CODE>, <A NAME="IDX6300"></A> <CODE>creation_options_entry/1</CODE>, <A NAME="IDX6301"></A> <CODE>creation_menu_name/1</CODE>. </UL> <LI><STRONG>Other modules used:</STRONG> <UL> <LI><EM>System library modules:</EM> <A NAME="IDX6302"></A> <CODE>objects/objects_rt</CODE>, <A NAME="IDX6303"></A> <CODE>tcltk_obj/window_class</CODE>, <A NAME="IDX6304"></A> <CODE>tcltk_obj/menu_entry_class</CODE>, <A NAME="IDX6305"></A> <CODE>tcltk/tcltk</CODE>, <A NAME="IDX6306"></A> <CODE>tcltk/tcltk_low_level</CODE>, <A NAME="IDX6307"></A> <CODE>lists</CODE>. </UL> </UL> </div class="cartouche"> <H2><A NAME="SEC553" HREF="ciao_toc.html#TOC553">Documentation on exports (<CODE>menu_class</CODE>)</A></H2> <P> <A NAME="IDX6308"></A> <A NAME="IDX6309"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>name_menu/1:</B> <DD><A NAME="IDX6310"></A> <P> <STRONG>Usage:</STRONG> <CODE>name_menu(+Name)</CODE> <UL> <LI><EM>Description:</EM> Indicates the <CODE>Name</CODE> of the menubutton associated. <LI><EM>Call and exit should be <EM>compatible</EM> with:</EM> <CODE>+Name</CODE> is currently instantiated to an atom. (<CODE>term_typing:atom/1</CODE>) </UL> </DL> <P> <A NAME="IDX6311"></A> <A NAME="IDX6312"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>menu_data/1:</B> <DD><A NAME="IDX6313"></A> <P> <STRONG>Usage 1:</STRONG> <CODE>menu_data(+Menu)</CODE> <UL> <LI><EM>Description:</EM> <CODE>Menu</CODE> posted when cascade entry is invoked. <LI><EM>Call and exit should be <EM>compatible</EM> with:</EM> <CODE>+Menu</CODE> is currently instantiated to an atom. (<CODE>term_typing:atom/1</CODE>) </UL> <P> <STRONG>Usage 2:</STRONG> <CODE>menu_data(-Menu)</CODE> <UL> <LI><EM>Description:</EM> Gets the <CODE>Menu</CODE> asociated to the cascade entry. <LI><EM>Call and exit should be <EM>compatible</EM> with:</EM> <CODE>-Menu</CODE> is currently instantiated to an atom. (<CODE>term_typing:atom/1</CODE>) </UL> </DL> <P> <A NAME="IDX6314"></A> <A NAME="IDX6315"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>label_value/1:</B> <DD><A NAME="IDX6316"></A> <P> <STRONG>Usage 1:</STRONG> <CODE>label_value(+Value)</CODE> <UL> <LI><EM>Description:</EM> <CODE>Value</CODE> specifies a string to be displayed as an identifying label in the menu entry. <LI><EM>Call and exit should be <EM>compatible</EM> with:</EM> <CODE>+Value</CODE> is currently instantiated to an atom. (<CODE>term_typing:atom/1</CODE>) </UL> <P> <STRONG>Usage 2:</STRONG> <CODE>label_value(-Value)</CODE> <UL> <LI><EM>Description:</EM> Gets the string which identify the menu entry. <LI><EM>Call and exit should be <EM>compatible</EM> with:</EM> <CODE>-Value</CODE> is currently instantiated to an atom. (<CODE>term_typing:atom/1</CODE>) </UL> </DL> <P> <A NAME="IDX6317"></A> <A NAME="IDX6318"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>tearoff_value/1:</B> <DD><A NAME="IDX6319"></A> <P> <STRONG>Usage 1:</STRONG> <CODE>tearoff_value(+Tearoff)</CODE> <UL> <LI><EM>Description:</EM> <CODE>Tearoff</CODE> must have a proper boolean value, which specifies wheter or not the menu should include a tear-off entry at the top. Defaults to 1. <LI><EM>Call and exit should be <EM>compatible</EM> with:</EM> <CODE>+Tearoff</CODE> is currently instantiated to an atom. (<CODE>term_typing:atom/1</CODE>) </UL> <P> <STRONG>Usage 2:</STRONG> <CODE>tearoff_value(-Tearoff)</CODE> <UL> <LI><EM>Description:</EM> Gets the <CODE>Tearoff</CODE> value <LI><EM>Call and exit should be <EM>compatible</EM> with:</EM> <CODE>-Tearoff</CODE> is currently instantiated to an atom. (<CODE>term_typing:atom/1</CODE>) </UL> </DL> <P> <A NAME="IDX6320"></A> <A NAME="IDX6321"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>tcl_name/1:</B> <DD><A NAME="IDX6322"></A> <P> <STRONG>Usage:</STRONG> <CODE>tcl_name(-Widget)</CODE> <UL> <LI><EM>Description:</EM> Specifies the name of the <CODE>Widget</CODE>. In this case is menu. <LI><EM>Call and exit should be <EM>compatible</EM> with:</EM> <CODE>-Widget</CODE> is currently instantiated to an atom. (<CODE>term_typing:atom/1</CODE>) </UL> </DL> <P> <A NAME="IDX6323"></A> <A NAME="IDX6324"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>creation_options/1:</B> <DD><A NAME="IDX6325"></A> <P> <STRONG>Usage:</STRONG> <CODE>creation_options(-OptionsList)</CODE> <UL> <LI><EM>Description:</EM> Creates a list with the options supported by the menu. <LI><EM>Call and exit should be <EM>compatible</EM> with:</EM> <CODE>-OptionsList</CODE> is a list. (<CODE>basic_props:list/1</CODE>) </UL> </DL> <P> <A NAME="IDX6326"></A> <A NAME="IDX6327"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>creation_options_entry/1:</B> <DD><A NAME="IDX6328"></A> <P> <STRONG>Usage:</STRONG> <CODE>creation_options_entry(-OptionsList)</CODE> <UL> <LI><EM>Description:</EM> Creates a list with the options of the menu entry. <LI><EM>Call and exit should be <EM>compatible</EM> with:</EM> <CODE>-OptionsList</CODE> is a list. (<CODE>basic_props:list/1</CODE>) </UL> </DL> <P> <A NAME="IDX6329"></A> <A NAME="IDX6330"></A> <DL> <DT><span class="define">PREDICATE:</span> <B>creation_menu_name/1:</B> <DD><A NAME="IDX6331"></A> <P> <STRONG>Usage:</STRONG> <CODE>creation_menu_name(-OptionsList)</CODE> <UL> <LI><EM>Description:</EM> Creates a list with the name of the menu. <LI><EM>Call and exit should be <EM>compatible</EM> with:</EM> <CODE>-OptionsList</CODE> is a list. (<CODE>basic_props:list/1</CODE>) </UL> </DL> <P><HR><P> Go to the <A HREF="ciao_1.html">first</A>, <A HREF="ciao_128.html">previous</A>, <A HREF="ciao_130.html">next</A>, <A HREF="ciao_241.html">last</A> section, <A HREF="ciao_toc.html">table of contents</A>. </BODY> </HTML>
