File: cs_243.html

package info (click to toggle)
crystalspace 0.94-20020412-3
links: PTS
area: main
in suites: woody
size: 62,276 kB
ctags: 52,843
sloc: cpp: 274,783; ansic: 6,608; perl: 6,276; objc: 3,952; asm: 2,942; python: 2,354; php: 542; pascal: 530; sh: 430; makefile: 370; awk: 193
file content (188 lines) | stat: -rw-r--r-- 6,307 bytes
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- Created by texi2html 1.64 -->
<!-- 
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
            Karl Berry  <karl@freefriends.org>
            Olaf Bachmann <obachman@mathematik.uni-kl.de>
            and many others.
Maintained by: Olaf Bachmann <obachman@mathematik.uni-kl.de>
Send bugs and suggestions to <texi2html@mathematik.uni-kl.de>
 
-->
<HTML>
<HEAD>
<TITLE>Crystal Space: AWS List Box</TITLE>

<META NAME="description" CONTENT="Crystal Space: AWS List Box">
<META NAME="keywords" CONTENT="Crystal Space: AWS List Box">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="texi2html 1.64">

</HEAD>

<BODY LANG="" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#800080" ALINK="#FF0000">

<A NAME="SEC598"></A>
<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="cs_242.html#SEC595"> &lt; </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="cs_244.html#SEC603"> &gt; </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="cs_235.html#SEC568"> &lt;&lt; </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="cs_236.html#SEC569"> Up </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="cs_244.html#SEC603"> &gt;&gt; </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="index.html#SEC_Top">Top</A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="cs_toc.html#SEC_Contents">Contents</A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="cs_285.html#SEC711">Index</A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="cs_abt.html#SEC_About"> ? </A>]</TD>
</TR></TABLE>
<HR SIZE=1>
<H4> 7.12.5.7 List Box </H4>
<!--docid::SEC598::-->
<P>

A list box's type is "List Box".
</P><P>

<A NAME="SEC599"></A>
<H4> Signals      </H4>
<!--docid::SEC599::-->
<P>

List boxes send the following signals.
</P><P>

<DL COMPACT>
<DT><CODE>signalListBoxSelectionChanged</CODE>
<DD>Occurs when the currently selected item changes.
</DL>
<P>

<A NAME="SEC600"></A>
<H4> Actions  </H4>
<!--docid::SEC600::-->
<P>

List boxes understand the following actions.
</P><P>

<DL COMPACT>
<DT><CODE>InsertItem</CODE>
<DD>Inserts a new item. See below for parameters. Note that an item
does not need to have text or image or state, but it should have
one of the above.
</DL>
<P>

<A NAME="SEC601"></A>
<H4> Input Parameters </H4>
<!--docid::SEC601::-->
<P>

This sections describes the input parameters understood by the list box's
`<SAMP>InsertItem</SAMP>' action.
</P><P>

<TABLE>
<TR><TD><EM>Name</EM></TD>
</TD><TD> <EM>Type</EM>
</TD><TD> <EM>Description</EM>

</TR>
<TR><TD><CODE>textX</CODE></TD>
</TD><TD> <CODE>iString*</CODE>
</TD><TD> Text for the item in column <EM>X</EM>.

</TR>
<TR><TD><CODE>imageX</CODE></TD>
</TD><TD> <CODE>iString*</CODE>
</TD><TD> Pathname of the image in column <EM>X</EM>.

</TR>
<TR><TD><CODE>statefulX</CODE></TD>
</TD><TD> <CODE>bool</CODE>
</TD><TD> `<SAMP>true</SAMP>' if the item in column <EM>X</EM> needs a state box (like a
check box or radio button).

</TR>
<TR><TD><CODE>stateX</CODE></TD>
</TD><TD> <CODE>bool</CODE>
</TD><TD> State of the item in column <EM>X</EM>.

</TR>
<TR><TD><CODE>groupstateX</CODE></TD>
</TD><TD> <CODE>bool</CODE>
</TD><TD> If `<SAMP>true</SAMP>', the item in column <EM>X</EM> will have a radio button-type
state box instead of the default check box-style state.

</TR>
<TR><TD><CODE>selectableX</CODE></TD>
</TD><TD> <CODE>bool</CODE>
</TD><TD> If `<SAMP>false</SAMP>', then the item is not selectable and will never be
highlighted.  This is useful for items that have state of some sort and aren't
intended to be "picked" out of a list.

</TR>
<TR><TD><CODE>aligntxtX</CODE></TD>
</TD><TD> <CODE>int</CODE>
</TD><TD> Alignment of the text in column <EM>X</EM>.  By default, all text is
left-aligned.  This can be 0 or 1.  Zero is left-align; 1 is right-align.  If
there is state, it will be aligned with the text.

</TR>
<TR><TD><CODE>alignimgX</CODE></TD>
</TD><TD> <CODE>int</CODE>
</TD><TD> This is the same as `<SAMP>aligntxtX</SAMP>', except that it operates on the
image.

</TR>
<TR><TD><CODE>parent</CODE></TD>
</TD><TD> <CODE>int</CODE>
</TD><TD> Key that identifies the parent of which this item should be a child.  This
will turn the new item into a child item.
</TR></TABLE>
<P>

<A NAME="SEC602"></A>
<H4> Output Parameters </H4>
<!--docid::SEC602::-->
<P>

This sections describes the output parameters of the list box's
`<SAMP>InsertItem</SAMP>' action.
</P><P>

<TABLE>
<TR><TD><EM>Name</EM></TD>
</TD><TD> <EM>Type</EM>
</TD><TD> <EM>Description</EM>

</TR>
<TR><TD>`<SAMP>key</SAMP>'</TD>
</TD><TD> `<SAMP>int</SAMP>'
</TD><TD> Unique key of this item.  This can be saved and used as the value of a
parent when adding children to an item, or it may be saved and used with the
`<SAMP>GetState</SAMP>' action.

</TR></TABLE>
<A NAME="AWS Architecture"></A>
<HR SIZE=1>
<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="cs_242.html#SEC595"> &lt; </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="cs_244.html#SEC603"> &gt; </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="cs_235.html#SEC568"> &lt;&lt; </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="cs_236.html#SEC569"> Up </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="cs_244.html#SEC603"> &gt;&gt; </A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="index.html#SEC_Top">Top</A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="cs_toc.html#SEC_Contents">Contents</A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="cs_285.html#SEC711">Index</A>]</TD>
<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="cs_abt.html#SEC_About"> ? </A>]</TD>
</TR></TABLE>
<BR>  
<FONT SIZE="-1">
This document was generated

using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html
"><I>texi2html</I></A>

</BODY>
</HTML>