Sophie

Sophie

distrib > Mageia > 7 > i586 > media > core-release > by-pkgid > a2116f36018873d572acbcadddb8e994 > files > 2363

clanlib0.8-docs-0.8.1-22.mga7.i586.rpm


<!-- clanlib header begin -->
<HTML>
<HEAD>
<TITLE>CL_Menu - ClanLib Game SDK</TITLE>
<STYLE TYPE="text/css"><!--
HTML BODY
{
	font-family: verdana, helvetica, sans-serif;
	font-size: 12px;
}
H1 { font-size: 22px; }
H2 { font-size: 18px; }
H3 { font-size: 16px; }
H4 { font-size: 14px; }
P { font-size: 12px; }
LI { font-size: 12px; }
--></STYLE>
</HEAD>

<body bgcolor=white text=black link=blue vlink=#800080>

<center>
<img src="http://clanlib.org/gfx/clanlib.png">
</center>
<!-- clanlib header end -->

<center>
<p>
<a href="http://clanlib.org/docs.html">Home</a> |
<a href="classes.html">All Classes</a> |
<a href="modules.html">Grouped Classes</a> |
<a href="index.html">Index</a> |
<a href="search.html">Search</a>
</p>
</center>
<h1>Class CL_Menu</h1>
<p>  Menu component <a href="#description">More...</a></p>
<p>Derived from:
<a href="CL_Component.html">CL_Component</a>
<br>
Derived by:
<i>none</i>
<br>Group: GUI (Controls)</p>
<p>
#include &lt;ClanLib/gui.h&gt;
<p>
<table border=0 width=100%>
</table>
<p><b>Construction:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_Menu__CL_Menu.html">CL_Menu</a></p></td><td valign=top><p>  CL_Menu Constructor</p></td></tr></table>
<p><b>Attributes:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_Menu__is_open.html">is_open</a></p></td><td valign=top><p>  Returns true if the menu is open</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__is_vertical.html">is_vertical</a></p></td><td valign=top><p>  Returns true if the menu is vertical, false if horizontal</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__is_root_collapsing.html">is_root_collapsing</a></p></td><td valign=top><p>  Returns true if the root menu collapses when a click outside the menus takes place.
  Ignored by non-root menus.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__is_auto_resize.html">is_auto_resize</a></p></td><td valign=top><p>  Returns true if menu resized automatically when its parent is resized.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__has_mouse_over.html">has_mouse_over</a></p></td><td valign=top><p>  Returns true if the mouse cursor is on top of the menu</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__has_mouse_in_submenus.html">has_mouse_in_submenus</a></p></td><td valign=top><p>  Returns true if the mouse cursor is in a open submenu of the menu</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__get_parent_node.html">get_parent_node</a></p></td><td valign=top><p>  Returns the parent node of this menu.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__get_root_menu.html">get_root_menu</a></p></td><td valign=top><p>  Returns the top level parent of the menu tree.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__get_node_list.html">get_node_list</a></p></td><td valign=top><p>  Returns a list containing the CL_MenuNode's in this menu.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__get_items_height.html">get_items_height</a></p></td><td valign=top><p>  Returns the total height of items in a menu</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__get_items_width.html">get_items_width</a></p></td><td valign=top><p>  Returns the total width of items in a menu</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__is_click_to_open.html">is_click_to_open</a></p></td><td valign=top><p>  Returns true if the menus submenus need to be clicked to open.
  By default they open on mouse enter for vertical menus and
  on click with horizontal menus when it doesn't have focus.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__get_menu.html">get_menu</a></p></td><td valign=top><p>  Returns a pointer to the menu in the path given, or 0 if no such menu exsists.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__get_node.html">get_node</a></p></td><td valign=top><p>  Returns a pointer to the menu node in the path given, or 0 if no such menu exsists.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__get_item.html">get_item</a></p></td><td valign=top><p>  Returns a pointer to the menu item (CL_Component*) in the path given, or 0 if no such menu item exsists.</p></td></tr></table>
<p><b>Signals:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_Menu__sig_reposition.html">sig_reposition</a></p></td><td valign=top><p>  This signal is emitted when a repositioning of the menus is requsted.</p></td></tr></table>
<p><b>Operations:</b></p>
<table border=0 width=100%>
<tr><td width=30% valign=top><p><a href="CL_Menu__reposition.html">reposition</a></p></td><td valign=top><p>  Calculates a position and size for the menu, using code in the GUI theme.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__set_auto_resize.html">set_auto_resize</a></p></td><td valign=top><p>  Makes the menu resize automatically when its parent is resized</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__set_vertical.html">set_vertical</a></p></td><td valign=top><p>  Makes the menu vertical (true) or horizontal (false).</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__set_root_collapsing.html">set_root_collapsing</a></p></td><td valign=top><p>  Set weather the root menu should collapse when a click outside the menus takes place.
  Ignored by non-root menus.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__add_node.html">add_node</a></p></td><td valign=top><p>  Add a CL_MenuNode to the menu.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__remove_node.html">remove_node</a></p></td><td valign=top><p>  Remove a CL_MenuNode from the menu.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__set_parent_node.html">set_parent_node</a></p></td><td valign=top><p>  Set the parent node of this menu.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__open.html">open</a></p></td><td valign=top><p>  Open the menu.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__collapse.html">collapse</a></p></td><td valign=top><p>  Close the menu.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__collapse_submenus.html">collapse_submenus</a></p></td><td valign=top><p>  Close all submenus of the menu.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__set_click_to_open.html">set_click_to_open</a></p></td><td valign=top><p>  Set the opening mode of submenus to open on click (true) or open on mouse over (false)</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__create_menu.html">create_menu</a></p></td><td valign=top><p>  Convenience function for easy creation of menus.
  Creates needed menus, items and nodes automatically</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__create_node.html">create_node</a></p></td><td valign=top><p>  Convenience function for easy creation of menus.
  Creates needed menus, items and nodes automatically</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__create_item.html">create_item</a></p></td><td valign=top><p>  Convenience function for easy creation of menus.
  Creates needed menus, items and nodes automatically
  Returns the parent node of the created item.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_Menu__create_toggle_item.html">create_toggle_item</a></p></td><td valign=top><p>  Convenience function for easy creation of menus.
  Creates a toggling menu item in the specified path.
  Returns the parent node of the created item.</p></td></tr></table>
<a name="#description"><p><b>Detailed description:</b></p>
  !group=GUI/Controls!
  !header=gui.h!


<!-- clanlib footer begin -->

<center><br><br><font color="#a0a0a0">
Questions or comments, write to the <a href="http://clanlib.org/contact.html">ClanLib mailing list</a>.
</font></center>

</body>
</html>
<!-- clanlib footer end -->