groupcontrol.h

Go to the documentation of this file.

/*
 * Vega Strike
 * Copyright (C) 2003 Mike Byron
 *
 * http://vegastrike.sourceforge.net/
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

#ifndef __GROUPCONTROL_H__
#define __GROUPCONTROL_H__

#include "gui/control.h"

//See cpp file for detailed descriptions of classes, functions, etc.

//The group control is simply a collection of controls that can be
//manipulated as one.
//Note that this Control "owns" the controls under it.  They are deleted
//when this control is deleted.
class GroupControl : public Control
{
public:
//Whether this control has children.
    virtual bool hasGroupChildren( void )
    {
        return true;
    }

//Add a new control to this collection.
    void addChild( Control *child );

//Delete a control that is in this collection.
//Returns true if successful.
    bool deleteControl( Control *c );

//Take a control away from this collection and save it elsewhere.
    Control * removeControlFromGroup( Control *c );

//Find a control using its id.  NULL returned if none found.
//Note that the control may be hidden.
    Control * findControlById( const std::string &id );

//Number of child controls.
    int childCount( void )
    {
        return m_controls.size();
    }

//A control in this group.
    Control * childAt( int index )
    {
        return m_controls[index];
    }

//Draw the control.
//This should not draw outside its rectangle!
    virtual void draw( void );

//OVERRIDES
    virtual bool processMouseDown( const InputEvent &event );
    virtual bool processMouseUp( const InputEvent &event );
    virtual bool processMouseMove( const InputEvent &event );
    virtual bool processMouseDrag( const InputEvent &event );

//CONSTRUCTION
public: GroupControl( void ) {}
    virtual ~GroupControl( void );

//INTERNAL IMPLEMENTATION
protected:

//VARIABLES
protected:
    std::vector< Control* >m_controls;
};

#endif   //__GROUPCONTROL_H__