Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   
VCF::DefaultMenuItem

VCF::DefaultMenuItem Class Reference

#include <vcf/ApplicationKit/DefaultMenuItem.h>

Inheritance diagram for VCF::DefaultMenuItem:

VCF::MenuItem VCF::Item VCF::UIComponent VCF::Component VCF::ObjectWithCallbacks VCF::Object VCF::SeparatorMenuItem List of all members.

Public Member Functions

 DefaultMenuItem ()
 DefaultMenuItem (const String &caption, MenuItem *parent=NULL, Menu *menuOwner=NULL)
virtual ~DefaultMenuItem ()
void init ()
virtual bool containsPoint (Point *pt)
virtual uint32 getIndex () const
virtual void setIndex (const uint32 &index)
virtual void paint (GraphicsContext *context, Rect *paintRect)
virtual bool isSelected () const
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 () const
virtual void setChecked (const bool &checked)
virtual bool hasParent () const
virtual bool hasChildren () const
virtual uint32 getChildCount () const
virtual Menu * getMenuOwner () const
 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 () const
virtual void setParent (MenuItem *parent)
virtual MenuItem * getChildAt (const uint32 &index)
virtual MenuItem * findChildNamed (const String &name, const bool &exactMatch=true)
 Searches all the children of this menu item for the first child menu item whose name exactly matches the name parameter.
virtual bool isEnabled () const
virtual void setEnabled (const bool &enabled)
virtual bool isVisible () const
virtual void setVisible (const bool &visible)
virtual bool getRadioItem () const
virtual void setRadioItem (const bool &value)
virtual void setCaption (const String &caption)
virtual String getCaption () const
virtual MenuItemPeer * getPeer () const
virtual bool isSeparator () const
virtual void setSeparator (const bool &separator)
virtual bool isHighlighted () const
virtual void setHighlighted (const bool &val)
virtual void click ()
virtual void update ()
virtual void setImageIndex (const int32 &imageIndex)
virtual bool canPaint () const
 indicates whether the item can paint itself.
virtual void setCanPaint (const bool &val)
virtual void setAcceleratorKeyInfo (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 () const
 Returns the accelerator for the menu item.
virtual uint32 getChildIndex (MenuItem *child) const
virtual Object * clone (bool deep=false) const
 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

Array< MenuItem * > menuItems_
String caption_
Menu * menuOwner_
MenuItem * parent_
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 (   )  const [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.

Reimplemented from 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  )  const [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]
 

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,
const bool &  exactMatch = true
)  [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.

Parameters:
String the name to match against
bool indicates whether or not the match should be exact. If it's true the mactch is exact, if it's false the search is case insensitive. For example, if you were to pass in "foo" for name, and false for exactMatch 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 (   )  const [virtual]
 

Returns the accelerator for the menu item.

Implements VCF::MenuItem.

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

Implements VCF::MenuItem.

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

Implements VCF::MenuItem.

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

Implements VCF::MenuItem.

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

Implements VCF::MenuItem.

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

Implements VCF::MenuItem.

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

Implements VCF::MenuItem.

virtual Menu* VCF::DefaultMenuItem::getMenuOwner (   )  const [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 (   )  const [virtual]
 

Implements VCF::MenuItem.

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

Implements VCF::MenuItem.

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

Implements VCF::MenuItem.

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::UIComponent.

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

Implements VCF::MenuItem.

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

Implements VCF::MenuItem.

void VCF::DefaultMenuItem::init (   ) 
 

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

Implements VCF::MenuItem.

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

Implements VCF::MenuItem.

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

Implements VCF::MenuItem.

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

Implements VCF::MenuItem.

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

Reimplemented from VCF::Item.

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

Implements VCF::MenuItem.

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

Implements VCF::MenuItem.

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

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

Reimplemented from 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::setAcceleratorKeyInfo (  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::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::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]
 

Reimplemented from VCF::Item.

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

Implements VCF::MenuItem.

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]
 

Reimplemented from VCF::Item.

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

Implements VCF::MenuItem.

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

Implements VCF::MenuItem.

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

Implements VCF::MenuItem.

Member Data Documentation

String VCF::DefaultMenuItem::caption_ [protected]
 

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

Array<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:
   Comments or Suggestions?    License Information