Inheritance diagram for Exponent::GUI::Controls::CControlPanel:
Definition at line 37 of file CControlPanel.hpp.
Exponent::GUI::Controls::CControlPanel::CControlPanel | ( | IWindow * | parent, | |
IControlRoot * | root, | |||
const long | uniqueId, | |||
const CRect & | area, | |||
IActionListener * | listener = NULL | |||
) |
Construction
parent | THe parent window holding this control root | |
root | The root control that this control is being added to | |
uniqueId | The unique Identifier of this control or CCONTROL_NO_ID_REQUIRED if no id is required | |
area | The area of this control relative to the root controls top left | |
listener | The action listener |
CMyControlPanel::CMyControlPanel(IWindow *parent, IControlRoot *root, const long uniqueId, const CRect &area, IActionListener *listener) : CControlPanel(parent, root, uniqueId, area, listener) { // Notice that we are being added to root, not our children.... // Create our child controls, here we just create a generic control, but this could be any control that we choose // Notice that the area is set to be relative to *our* top left.. CControl *control = new CControl(this, 10, CRect(0, 0, 10, 10), NULL); // Now we add the control so that it will draw, recieve mouse moves etc... this->addControl(control); }
virtual Exponent::GUI::Controls::CControlPanel::~CControlPanel | ( | ) | [virtual] |
Destruction
virtual void Exponent::GUI::Controls::CControlPanel::addControl | ( | IControl * | control | ) | [virtual] |
Add a control
control | A control that becomes a child of this |
Reimplemented from Exponent::GUI::Controls::CControlRoot.
virtual void Exponent::GUI::Controls::CControlPanel::dereference | ( | ) | [inline, virtual] |
Dereference
Reimplemented from Exponent::GUI::Controls::CControl.
Definition at line 278 of file CControlPanel.hpp.
References Exponent::GUI::Controls::CControl::dereference().
virtual void Exponent::GUI::Controls::CControlPanel::disableControl | ( | ) | [virtual] |
Disable the control
Reimplemented from Exponent::GUI::Controls::CControl.
virtual void Exponent::GUI::Controls::CControlPanel::drawControl | ( | CGraphics & | graphics | ) | [virtual] |
Draw the control
graphics | The graphics context |
Reimplemented from Exponent::GUI::Controls::CControl.
Reimplemented in Exponent::GUI::Controls::CMenuItemDisplay, and Exponent::GUI::Controls::CScrollPanel.
virtual bool Exponent::GUI::Controls::CControlPanel::drawEnabledControl | ( | CGraphics & | graphics | ) | [protected, virtual] |
Check if the control is enabled. If it isnt, draw the disabled background and return
graphics | The graphics context |
bool | True if the control should be drawn, false otherwise |
Reimplemented from Exponent::GUI::Controls::CControl.
virtual void Exponent::GUI::Controls::CControlPanel::drawRootControl | ( | CGraphics & | graphics | ) | [virtual] |
Draw the root control
graphics | The graphics context |
Reimplemented from Exponent::GUI::Controls::CControlRoot.
virtual void Exponent::GUI::Controls::CControlPanel::enableControl | ( | ) | [virtual] |
Enable a control
Reimplemented from Exponent::GUI::Controls::CControl.
void Exponent::GUI::Controls::CControlPanel::flushSizeChange | ( | ) | [protected] |
Fluush throught a size change of some sort
virtual void Exponent::GUI::Controls::CControlPanel::getGlobalCoordinatesOfControl | ( | IControl * | control, | |
CPoint & | point | |||
) | [virtual] |
Get the global location of the control
control | The control to get the global coordinates of | |
point | On return contains the global position of the control |
Reimplemented from Exponent::GUI::Controls::CControlRoot.
virtual void Exponent::GUI::Controls::CControlPanel::getWindowCoordinatesOfControl | ( | IControl * | control, | |
CPoint & | point | |||
) | [virtual] |
Get the window (absoloute) position of a control
control | The control to find the absolute position of | |
point | The position of the control on return |
Reimplemented from Exponent::GUI::Controls::CControlRoot.
Reimplemented in Exponent::GUI::Controls::CScrollPanel.
virtual CPoint Exponent::GUI::Controls::CControlPanel::getWindowOffset | ( | ) | [virtual] |
Get window offset
CPoint | The window offset for this panel |
Reimplemented from Exponent::GUI::Controls::CControlRoot.
Reimplemented in Exponent::GUI::Controls::CScrollPanel.
virtual void Exponent::GUI::Controls::CControlPanel::handleDoubleClick | ( | CMouseEvent & | event | ) | [virtual] |
Handle a double click on the left button
event | The event to handle |
Reimplemented from Exponent::GUI::Controls::CControl.
Reimplemented in Exponent::GUI::Controls::CScrollPanel.
virtual void Exponent::GUI::Controls::CControlPanel::handleFileDrop | ( | const CDropEvent & | event | ) | [virtual] |
Handle a file drop
event | The event to handle |
Reimplemented from Exponent::GUI::Controls::CControl.
virtual bool Exponent::GUI::Controls::CControlPanel::handleKeyDown | ( | const CKeyboardEvent & | event | ) | [virtual] |
Handle key down events
event | The event to handle |
Reimplemented from Exponent::GUI::Controls::CControl.
virtual bool Exponent::GUI::Controls::CControlPanel::handleKeyUp | ( | const CKeyboardEvent & | event | ) | [virtual] |
Handle key up events
event | The event to handle |
Reimplemented from Exponent::GUI::Controls::CControl.
virtual void Exponent::GUI::Controls::CControlPanel::handleLeftButtonDown | ( | CMouseEvent & | event | ) | [virtual] |
Handle left button being clicked
event | The event to handle |
Reimplemented from Exponent::GUI::Controls::CControl.
Reimplemented in Exponent::GUI::Controls::CScrollPanel.
virtual void Exponent::GUI::Controls::CControlPanel::handleLeftButtonUp | ( | CMouseEvent & | event | ) | [virtual] |
Handle left button being released
event | The event to handle |
Reimplemented from Exponent::GUI::Controls::CControl.
Reimplemented in Exponent::GUI::Controls::CScrollPanel.
virtual void Exponent::GUI::Controls::CControlPanel::handleMouseLeavingArea | ( | CMouseEvent & | event | ) | [virtual] |
Handle a mouse leaving movement
event | The event to handle |
Reimplemented from Exponent::GUI::Controls::CControl.
Reimplemented in Exponent::GUI::Controls::CScrollPanel.
virtual void Exponent::GUI::Controls::CControlPanel::handleMouseMovement | ( | CMouseEvent & | event | ) | [virtual] |
Handle the mouse movement
event | The event to handle |
Reimplemented from Exponent::GUI::Controls::CControl.
Reimplemented in Exponent::GUI::Controls::CScrollPanel.
virtual void Exponent::GUI::Controls::CControlPanel::handleMouseScroll | ( | CMouseEvent & | event | ) | [virtual] |
Handle the scroll wheel
event | The event to handle |
Reimplemented from Exponent::GUI::Controls::CControl.
Reimplemented in Exponent::GUI::Controls::CScrollPanel.
virtual void Exponent::GUI::Controls::CControlPanel::handleRightButtonDown | ( | CMouseEvent & | event | ) | [virtual] |
Handle the right button being clicked
event | The event to handle |
Reimplemented from Exponent::GUI::Controls::CControl.
Reimplemented in Exponent::GUI::Controls::CScrollPanel.
virtual void Exponent::GUI::Controls::CControlPanel::handleRightButtonUp | ( | CMouseEvent & | event | ) | [virtual] |
Handle the right button being released
event | The event to handle |
Reimplemented from Exponent::GUI::Controls::CControl.
Reimplemented in Exponent::GUI::Controls::CScrollPanel.
virtual bool Exponent::GUI::Controls::CControlPanel::isContainer | ( | ) | const [inline, virtual] |
Is this control a container of other controls
bool | True, this control can contain others |
Reimplemented from Exponent::GUI::Controls::CControl.
Definition at line 112 of file CControlPanel.hpp.
virtual void Exponent::GUI::Controls::CControlPanel::lockControl | ( | IControl * | control | ) | [virtual] |
Lock a control (only this control recieves mouse info)
control | The control to feed all events to |
Reimplemented from Exponent::GUI::Controls::CControlRoot.
virtual void Exponent::GUI::Controls::CControlPanel::onDrawDrawThePanelBounds | ( | const bool | draw = true |
) | [inline, virtual] |
Should we draw the panel bounds?
draw | If true the panel bounding box will be drawn, if false will not. Useful during debugging |
Definition at line 249 of file CControlPanel.hpp.
References m_drawPanelBounds.
virtual void Exponent::GUI::Controls::CControlPanel::referenced | ( | ) | [inline, virtual] |
Reference
Reimplemented from Exponent::GUI::Controls::CControl.
Definition at line 269 of file CControlPanel.hpp.
References Exponent::GUI::Controls::CControl::referenced().
virtual void Exponent::GUI::Controls::CControlPanel::setArea | ( | const CRect & | area | ) | [virtual] |
Set the size of the control
area | The are of the control |
Reimplemented from Exponent::GUI::Controls::CControl.
Reimplemented in Exponent::GUI::Controls::CRadioButton.
virtual void Exponent::GUI::Controls::CControlPanel::setBoundsColour | ( | const CAlphaColour & | boundsColour | ) | [inline, virtual] |
Set the colour of the bounds
boundsColour | The colour of the bounding box |
Definition at line 261 of file CControlPanel.hpp.
References m_boundsColour.
virtual void Exponent::GUI::Controls::CControlPanel::setControlRoot | ( | IControlRoot * | controlRoot | ) | [virtual] |
Set the root control that this control is sitting on
controlRoot | The root control of this panel |
Reimplemented from Exponent::GUI::Controls::CControl.
void Exponent::GUI::Controls::CControlPanel::shouldClip | ( | const bool | clip = true |
) |
Should we clip children control
clip | If true clipping is applied, not recommended when placing inside a scroll panel |
virtual void Exponent::GUI::Controls::CControlPanel::unlockControl | ( | ) | [virtual] |
virtual void Exponent::GUI::Controls::CControlPanel::updateArea | ( | const CRect & | area | ) | [virtual] |
Update an area
area | The area relative to our top left to redraw |
Reimplemented from Exponent::GUI::Controls::CControlRoot.
Reimplemented in Exponent::GUI::Controls::CScrollPanel.
virtual void Exponent::GUI::Controls::CControlPanel::updateControl | ( | IControl * | control | ) | [virtual] |
Update (redraw) a control
control | The control to redraw |
Reimplemented from Exponent::GUI::Controls::CControlRoot.
Reimplemented in Exponent::GUI::Controls::CScrollPanel.
CAlphaColour Exponent::GUI::Controls::CControlPanel::m_boundsColour [protected] |
THe colour of the bounds
Definition at line 313 of file CControlPanel.hpp.
Referenced by setBoundsColour().
bool Exponent::GUI::Controls::CControlPanel::m_drawPanelBounds [protected] |
Should we draw the bounds of the panel
Definition at line 312 of file CControlPanel.hpp.
Referenced by onDrawDrawThePanelBounds().