os::MenuSeparator Class Reference
[The Syllable Graphical User Interface API]

Menu separator item. More...

Inheritance diagram for os::MenuSeparator:

List of all members.

Public Member Functions
	MenuSeparator ()
	~MenuSeparator ()
	internal
virtual Point	GetContentSize ()
	Gets the size of the separator.
virtual void	Draw ()
	Draws the os::MenuSeparator.
virtual void	DrawContent ()
virtual void	SetHighlighted (bool bHighlight)
	Tells the system to highlight or unhighlight this element.
virtual bool	IsSelectable () const
	Tells the system whether or not this item can be selected.

---

Detailed Description

Description:

A os::MenuSeparator can be inserted to a menu to categorize other items. The separator will draw an etched line in the menu.

Since:

0.3.7

See also:

os::MenuItem, os::Menu

Author:

Kurt Skauen ([email protected])

---

Constructor & Destructor Documentation

MenuSeparator::MenuSeparator

(

)

MenuSeparator::~MenuSeparator

(

)

---

Member Function Documentation

Point MenuSeparator::GetContentSize

(

)

[virtual]

..

Description:

Gets the size of the separator.

Returns:

This method returns the size as an os::Point.

See also:

Author:

Kurt Skauen(with modifications from the Syllable team)

Reimplemented from os::MenuItem.

void MenuSeparator::Draw

(

)

[virtual]

Description:

This method draws the Separator, make sure you call Flush() before calling this method.

See also:

os::View::Draw()

Author:

Kurt Skauen with modifications by the Syllable Team.

Reimplemented from os::MenuItem.

void MenuSeparator::DrawContent

(

)

[virtual]

void MenuSeparator::SetHighlighted

(

bool

bHighlight

)

[virtual]

..

Description:

This method will tell the system to highlight or unhighlight this element.

Parameters:

bHighlighted

- To highlight this element set this to true(default) and to unhighlight set this to false.

See also:

IsHighlighted()

Author:

Rick Caudill ([email protected])

Reimplemented from os::MenuItem.

virtual bool os::MenuSeparator::IsSelectable

(

)

const [inline, virtual]

Description:

Tells the system whether or not this item can be selected.

Author:

Rick Caudill([email protected])

Reimplemented from os::MenuItem.

---