Class cocos.menu.ToggleMenuItem

         object --+            
                  |            
cocosnode.CocosNode --+        
                      |        
               MenuItem --+    
                          |    
           MultipleMenuItem --+
                              |
                             ToggleMenuItem

A menu item for a boolean toggle option.

Example:

items.append( ToggleMenuItem('Show FPS:', self.on_show_fps, director.show_FPS) )

Methods

	__init__(self, label, callback_func, value=False) Creates a Toggle Menu Item
	on_key_press(self, symbol, mod)
	draw(self) This is the function you will have to override if you want your subclassed to draw something on screen. (Inherited from cocos.menu.MenuItem)
(x1,x2,y1,y2)	get_box(self) Returns the box that contains the menu item. (Inherited from cocos.menu.MenuItem)
bool	is_inside_box(self, x, y) Returns whether the point (x,y) is inside the menu item. (Inherited from cocos.menu.MenuItem)
	on_activated(self) (Inherited from cocos.menu.MenuItem)
	on_selected(self) (Inherited from cocos.menu.MenuItem)
	on_text(self, text) (Inherited from cocos.menu.MenuItem)
	on_unselected(self) (Inherited from cocos.menu.MenuItem)
Inherited from `cocosnode.CocosNode`: `__contains__`, `add`, `are_actions_running`, `do`, `get`, `get_ancestor`, `get_children`, `on_enter`, `on_exit`, `pause`, `pause_scheduler`, `remove`, `remove_action`, `resume`, `resume_scheduler`, `schedule`, `schedule_interval`, `stop`, `transform`, `unschedule`, `visit`, `walk` Inherited from `object`: `__delattr__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__repr__`, `__setattr__`, `__str__`

Properties

Inherited from object: __class__

Instance Variables

Inherited from cocosnode.CocosNode: actions, camera, children, children_anchor_x, children_anchor_y, children_names, grid, is_running, rotation, scale, scheduled_calls, scheduled_interval_calls, skip_frame, to_remove, transform_anchor_x, transform_anchor_y, visible, x, y

Class Variables

	activated_effect = `None` (Inherited from cocos.menu.MenuItem)
	selected_effect = `None` (Inherited from cocos.menu.MenuItem)
	unselected_effect = `None` (Inherited from cocos.menu.MenuItem)
Inherited from `cocosnode.CocosNode`: `anchor`, `anchor_x`, `anchor_y`, `children_anchor`, `parent`, `position`, `transform_anchor`

Method Details

init

(Constructor) __init__(self, label, callback_func, value=False)

Creates a Toggle Menu Item

Parameters:

label : string: Item's label
callback_func : function: Callback function
value : bool: Default value of the item: False is 'OFF', True is 'ON'. Default:False

Overrides:

MultipleMenuItem.__init__

on_key_press

on_key_press(self, symbol, mod)

Overrides:: MultipleMenuItem.on_key_press