The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page

VCF::DefaultMenuItem Class Reference

#include <vcf/ApplicationKit/DefaultMenuItem.h>

Inheritance diagram for VCF::DefaultMenuItem:

List of all members.

Public Member Functions
	DefaultMenuItem ()
	DefaultMenuItem (const String &caption, MenuItem *parent=NULL, Menu *menuOwner=NULL)
virtual	~DefaultMenuItem ()
void	init ()
	This is going to be removed from the bext release.
virtual bool	containsPoint (Point *pt)
	This is called to determine if a given point is within the bounds of the item.
virtual uint32	getIndex ()
	Returns the index of the item within it's model.
virtual void	setIndex (const uint32 &index)
virtual void *	getData ()
	Returns some application defined data.
virtual void	setData (void *data)
	Sets the application defined data.
virtual void	paint (GraphicsContext *context, Rect *paintRect)
virtual bool	isSelected ()
virtual void	setSelected (const bool &selected)
virtual Enumerator< MenuItem * > *	getChildren ()
virtual void	addChild (MenuItem *child)
virtual void	insertChild (const uint32 &index, MenuItem *child)
virtual void	deleteChild (MenuItem *child)
virtual void	deleteChild (const uint32 &index)
virtual void	clearChildren ()
virtual bool	isChecked ()
virtual void	setChecked (const bool &checked)
virtual bool	hasParent ()
virtual bool	hasChildren ()
virtual uint32	getChildCount ()
virtual Menu *	getMenuOwner ()
	returns the owner of the menu item.
virtual void	setMenuOwner (Menu *menuOwner)
	sets the Owner for the MenuItem and for all it's children as well
virtual MenuItem *	getParent ()
virtual void	setParent (MenuItem *parent)
virtual MenuItem *	getChildAt (const uint32 &index)
virtual MenuItem *	findChildNamedSimilarTo (const String &name)
	Searches all the children of this menu item for the first child menu item whose name roughly matches that of the named parameter.
virtual MenuItem *	findChildNamed (const String &name)
	Searches all the children of this menu item for the first child menu item whose name exactly matches the name parameter.
virtual bool	isEnabled ()
virtual void	setEnabled (const bool &enabled)
virtual bool	isVisible ()
virtual void	setVisible (const bool &visible)
virtual bool	getRadioItem ()
virtual void	setRadioItem (const bool &value)
virtual void	setCaption (const String &caption)
virtual String	getCaption ()
virtual MenuItemPeer *	getPeer ()
virtual bool	isSeparator ()
virtual void	setSeparator (const bool &separator)
virtual bool	isHighlighted ()
virtual void	setHighlighted (const bool &val)
virtual void	click ()
virtual void	update ()
virtual Rect *	getBounds ()
	returns the Bounds for the Item or NULL if not applicable.
virtual int32	getImageIndex ()
virtual void	setImageIndex (const int32 &imageIndex)
virtual bool	canPaint ()
	indicates whether the item can paint itself.
virtual void	setCanPaint (const bool &val)
virtual void	setBounds (Rect *bounds)
virtual int32	getStateImageIndex ()
	not supported
virtual void	setStateImageIndex (const int32 &index)
	not supported
virtual void	setAcceleratorKey (const VirtualKeyCode &keyCode, const uint32 &modifierMask)
	This sets the accelerator key object for the menu item.
virtual void	setAcceleratorKey (AcceleratorKey *accelerator)
	Sets the acclerator object for this menu item.
virtual AcceleratorKey *	getAccelerator ()
	Returns the accelerator for the menu item.
virtual uint32	getChildIndex (MenuItem *child)
virtual Object *	clone (bool deep=false)
	Makes a complete clone of this object.
virtual void	handleEvent (Event *event)
	generic handler method for events.
Protected Member Functions
void	onAccelerator (KeyboardEvent *e)
Protected Attributes
std::vector< MenuItem * >	menuItems_
EnumeratorContainer< std::vector< MenuItem * >, MenuItem * >	container_
String	caption_
void *	data_
Menu *	menuOwner_
MenuItem *	parent_
int32	imageIndex_
Rect	bounds_
AcceleratorKey *	currentAccelerator_

---

Constructor & Destructor Documentation

VCF::DefaultMenuItem::DefaultMenuItem (   )

VCF::DefaultMenuItem::DefaultMenuItem (  const String &  caption, MenuItem *  parent = NULL, Menu *  menuOwner = NULL )

virtual VCF::DefaultMenuItem::~DefaultMenuItem (   )  [virtual]

---

Member Function Documentation

virtual void VCF::DefaultMenuItem::addChild (  MenuItem *  child  )  [virtual]

Implements VCF::MenuItem.

virtual bool VCF::DefaultMenuItem::canPaint (   )  [virtual]

indicates whether the item can paint itself. In general this is often false, but when true, the control that contains the item should call the item's paint() method whenever the item needs repainting. Implements VCF::Item.

virtual void VCF::DefaultMenuItem::clearChildren (   )  [virtual]

Implements VCF::MenuItem.

virtual void VCF::DefaultMenuItem::click (   )  [virtual]

Implements VCF::MenuItem.

virtual Object* VCF::DefaultMenuItem::clone (  bool  deep = false  )  [virtual]

Makes a complete clone of this object. A typical implementation might be: virtual Object* clone( bool deep ) { return new MyObject( this ); } In which the implementer simply creates a new instance on the heap and calls the copy constructor. Objects which support cloning should also have a copy constructor defined as well. Parameters: bool  deep if deep is true then any object instances that this object owns should probably be cloned as well, with full new copies made. Otherwise it would be acceptable to simply copy the pointer values. The default value is for deep cloning to be false. Returns: Object a new instance that should be an copy of this. If the object doesn't support cloning the return will value will be NULL. Reimplemented from VCF::Object.

virtual bool VCF::DefaultMenuItem::containsPoint (  Point *  pt  )  [virtual]

This is called to determine if a given point is within the bounds of the item. The bounds may be slightly different than what is returned by getBounds(). For example, an item may not support getBounds(), but may have a non-rectangular region and may implement containsPoint() accordingly. Implements VCF::Item.

virtual void VCF::DefaultMenuItem::deleteChild (  const uint32 &  index  )  [virtual]

Implements VCF::MenuItem.

virtual void VCF::DefaultMenuItem::deleteChild (  MenuItem *  child  )  [virtual]

Implements VCF::MenuItem.

virtual MenuItem* VCF::DefaultMenuItem::findChildNamed (  const String &  name  )  [virtual]

Searches all the children of this menu item for the first child menu item whose name exactly matches the name parameter. This search is case sensitive. Returns: MenuItem the found menu item. If no item is found, return is NULL. Implements VCF::MenuItem.

virtual MenuItem* VCF::DefaultMenuItem::findChildNamedSimilarTo (  const String &  name  )  [virtual]

Searches all the children of this menu item for the first child menu item whose name roughly matches that of the named parameter. The search is case insensitive. For example, if you were to pass in "foo" and a menu item had a name of "FooBar" a match would occur. Returns: MenuItem the found menu item. If no item is found, return is NULL. Implements VCF::MenuItem.

virtual AcceleratorKey* VCF::DefaultMenuItem::getAccelerator (   )  [virtual]

Returns the accelerator for the menu item. Implements VCF::MenuItem.

virtual Rect* VCF::DefaultMenuItem::getBounds (   )  [inline, virtual]

returns the Bounds for the Item or NULL if not applicable. Implements VCF::Item.

virtual String VCF::DefaultMenuItem::getCaption (   )  [virtual]

Implements VCF::MenuItem.

virtual MenuItem* VCF::DefaultMenuItem::getChildAt (  const uint32 &  index  )  [virtual]

Implements VCF::MenuItem.

virtual uint32 VCF::DefaultMenuItem::getChildCount (   )  [virtual]

Implements VCF::MenuItem.

virtual uint32 VCF::DefaultMenuItem::getChildIndex (  MenuItem *  child  )  [virtual]

Implements VCF::MenuItem.

virtual Enumerator<MenuItem*>* VCF::DefaultMenuItem::getChildren (   )  [virtual]

Implements VCF::MenuItem.

virtual void* VCF::DefaultMenuItem::getData (   )  [virtual]

Returns some application defined data. This can be anything you want, hence the void* storage. Implements VCF::Item.

virtual int32 VCF::DefaultMenuItem::getImageIndex (   )  [inline, virtual]

Implements VCF::Item.

virtual uint32 VCF::DefaultMenuItem::getIndex (   )  [virtual]

Returns the index of the item within it's model. Implements VCF::Item.

virtual Menu* VCF::DefaultMenuItem::getMenuOwner (   )  [virtual]

returns the owner of the menu item. This generally is either a MenuBar or a PopupMenu Implements VCF::MenuItem.

virtual MenuItem* VCF::DefaultMenuItem::getParent (   )  [virtual]

Implements VCF::MenuItem.

virtual MenuItemPeer* VCF::DefaultMenuItem::getPeer (   )  [virtual]

Implements VCF::MenuItem.

virtual bool VCF::DefaultMenuItem::getRadioItem (   )  [virtual]

Implements VCF::MenuItem.

virtual int32 VCF::DefaultMenuItem::getStateImageIndex (   )  [inline, virtual]

not supported Implements VCF::Item.

virtual void VCF::DefaultMenuItem::handleEvent (  Event *  event  )  [virtual]

generic handler method for events. All UI events are sent here and then dispatched accordingly to a more specific event handler. If an Application class is present, then it is given a chance to "see" the event first before delegating it to the Component. All events are dispatched by their type so it is important to correctly identify the event objects type if you would like it to be dispatched correctly. The method will call the appropriate component method, like afterCreate(), beforeDestroy(), etc. Parameters: Event  based on the value returned by Event::getType(), Reimplemented from VCF::Component.

virtual bool VCF::DefaultMenuItem::hasChildren (   )  [virtual]

Implements VCF::MenuItem.

virtual bool VCF::DefaultMenuItem::hasParent (   )  [virtual]

Implements VCF::MenuItem.

void VCF::DefaultMenuItem::init (   )

This is going to be removed from the bext release. Deprecated: Reimplemented from VCF::Object.

virtual void VCF::DefaultMenuItem::insertChild (  const uint32 &  index, MenuItem *  child )  [virtual]

Implements VCF::MenuItem.

virtual bool VCF::DefaultMenuItem::isChecked (   )  [virtual]

Implements VCF::MenuItem.

virtual bool VCF::DefaultMenuItem::isEnabled (   )  [virtual]

Implements VCF::MenuItem.

virtual bool VCF::DefaultMenuItem::isHighlighted (   )  [virtual]

Implements VCF::MenuItem.

virtual bool VCF::DefaultMenuItem::isSelected (   )  [virtual]

Implements VCF::Item.

virtual bool VCF::DefaultMenuItem::isSeparator (   )  [virtual]

Implements VCF::MenuItem.

virtual bool VCF::DefaultMenuItem::isVisible (   )  [virtual]

Implements VCF::MenuItem.

void VCF::DefaultMenuItem::onAccelerator (  KeyboardEvent *  e  )  [protected]

virtual void VCF::DefaultMenuItem::paint (  GraphicsContext *  context, Rect *  paintRect )  [virtual]

Implements VCF::Item.

virtual void VCF::DefaultMenuItem::setAcceleratorKey (  AcceleratorKey *  accelerator  )  [virtual]

Sets the acclerator object for this menu item. If one already exists then it is removed. Implements VCF::MenuItem.

virtual void VCF::DefaultMenuItem::setAcceleratorKey (  const VirtualKeyCode &  keyCode, const uint32 &  modifierMask )  [virtual]

This sets the accelerator key object for the menu item. If one already exists it is removed for this menu item. The accelerator is assigned the key code and modifier mask passed in, and is given a default event handler, determined by the implementor. A menu item may have only one accelerator associated with it at any given time. Implements VCF::MenuItem.

virtual void VCF::DefaultMenuItem::setBounds (  Rect *  bounds  )  [virtual]

Implements VCF::Item.

virtual void VCF::DefaultMenuItem::setCanPaint (  const bool &  val  )  [virtual]

Implements VCF::MenuItem.

virtual void VCF::DefaultMenuItem::setCaption (  const String &  caption  )  [virtual]

Implements VCF::MenuItem.

virtual void VCF::DefaultMenuItem::setChecked (  const bool &  checked  )  [virtual]

Implements VCF::MenuItem.

virtual void VCF::DefaultMenuItem::setData (  void *  data  )  [virtual]

Sets the application defined data. Implements VCF::Item.

virtual void VCF::DefaultMenuItem::setEnabled (  const bool &  enabled  )  [virtual]

Implements VCF::MenuItem.

virtual void VCF::DefaultMenuItem::setHighlighted (  const bool &  val  )  [virtual]

Implements VCF::MenuItem.

virtual void VCF::DefaultMenuItem::setImageIndex (  const int32 &  imageIndex  )  [virtual]

Implements VCF::Item.

virtual void VCF::DefaultMenuItem::setIndex (  const uint32 &  index  )  [virtual]

Implements VCF::Item.

virtual void VCF::DefaultMenuItem::setMenuOwner (  Menu *  menuOwner  )  [virtual]

sets the Owner for the MenuItem and for all it's children as well Implements VCF::MenuItem.

virtual void VCF::DefaultMenuItem::setParent (  MenuItem *  parent  )  [virtual]

Implements VCF::MenuItem.

virtual void VCF::DefaultMenuItem::setRadioItem (  const bool &  value  )  [virtual]

Implements VCF::MenuItem.

virtual void VCF::DefaultMenuItem::setSelected (  const bool &  selected  )  [virtual]

Implements VCF::Item.

virtual void VCF::DefaultMenuItem::setSeparator (  const bool &  separator  )  [virtual]

Implements VCF::MenuItem.

virtual void VCF::DefaultMenuItem::setStateImageIndex (  const int32 &  index  )  [inline, virtual]

not supported Implements VCF::Item.

virtual void VCF::DefaultMenuItem::setVisible (  const bool &  visible  )  [virtual]

Implements VCF::MenuItem.

virtual void VCF::DefaultMenuItem::update (   )  [virtual]

Implements VCF::MenuItem.

---

Member Data Documentation

Rect VCF::DefaultMenuItem::bounds_ [protected]

String VCF::DefaultMenuItem::caption_ [protected]

EnumeratorContainer<std::vector<MenuItem*>, MenuItem*> VCF::DefaultMenuItem::container_ [protected]

AcceleratorKey* VCF::DefaultMenuItem::currentAccelerator_ [protected]

void* VCF::DefaultMenuItem::data_ [protected]

int32 VCF::DefaultMenuItem::imageIndex_ [protected]

std::vector<MenuItem*> VCF::DefaultMenuItem::menuItems_ [protected]

Menu* VCF::DefaultMenuItem::menuOwner_ [protected]

MenuItem* VCF::DefaultMenuItem::parent_ [protected]

---

The documentation for this class was generated from the following file:

• vcf/ApplicationKit/DefaultMenuItem.h

Comments or Suggestions?    License Information