ilikecats/stk-code_catmod
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixed #944: Fixed coding style, added docs.

Browse Source 
Thanks to quentin-bellay.


git-svn-id: svn+ssh://svn.code.sf.net/p/supertuxkart/code/main/trunk@12711 178a84e3-b1eb-0310-8ba1-8eac791a3b58
This commit is contained in:
hikerstk 2013-04-29 06:50:23 +00:00
parent 110a4d04d7
commit eaed4f1acd
2 changed files with 83 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
src/guiengine/abstract_top_level_container.cpp
View File

@ -22,18 +22,20 @@
#include "guiengine/widget.hpp" #include "guiengine/widget.hpp"
#include "io/file_manager.hpp" #include "io/file_manager.hpp"
#include "utils/ptr_vector.hpp" #include "utils/ptr_vector.hpp"
#include <iostream> #include <iostream>
#include <IGUIElement.h> #include <IGUIElement.h>
using namespace GUIEngine; using namespace GUIEngine;
using namespace irr;
using namespace core; using namespace core;
using namespace gui;
using namespace io;
using namespace irr;
using namespace scene; using namespace scene;
using namespace video; using namespace video;
using namespace io;
using namespace gui;
AbstractTopLevelContainer::AbstractTopLevelContainer() AbstractTopLevelContainer::AbstractTopLevelContainer()
{ {
@ -41,6 +43,12 @@ AbstractTopLevelContainer::AbstractTopLevelContainer()
m_last_widget = NULL; m_last_widget = NULL;
} }
// ----------------------------------------------------------------------------
/** This function adds a list of widgets recursively, effectively creating the hierarchy
* of widgets.
* \param widgets The vector of widgets to add
* \param parent The parent widget of the vector of widgets */
void AbstractTopLevelContainer::addWidgetsRecursively( void AbstractTopLevelContainer::addWidgetsRecursively(
PtrVector<Widget>& widgets, PtrVector<Widget>& widgets,
Widget* parent) Widget* parent)
@ -81,12 +89,16 @@ void AbstractTopLevelContainer::addWidgetsRecursively(
widgets[n].add(); widgets[n].add();
} }
} // next widget } // for n in all widgets
} // addWidgetsRecursively } // addWidgetsRecursively
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
/** This function checks recursively if a widget is a child of a vector of widgets
* \param within The vector of widgets that may contain the widget
* \param widget The widget that needs to be checked if it is in within
* \return True if the widget is in within, false otherwise */
bool isMyChildHelperFunc(const PtrVector<Widget>* within, const Widget* widget) bool isMyChildHelperFunc(const PtrVector<Widget>* within, const Widget* widget)
{ {
if (within->size() == 0) return false; if (within->size() == 0) return false;
@ -108,13 +120,21 @@ bool isMyChildHelperFunc(const PtrVector<Widget>* within, const Widget* widget)
return false; return false;
} }
// ----------------------------------------------------------------------------
/** This function checks if a widget is a child of the container.
* \param widget The widget that needs to be checked if it is a child
* \return True if the widget is a child, false otherwise */
bool AbstractTopLevelContainer::isMyChild(Widget* widget) const bool AbstractTopLevelContainer::isMyChild(Widget* widget) const
{ {
return isMyChildHelperFunc(&m_widgets, widget); return isMyChildHelperFunc(&m_widgets, widget);
} }
// ----------------------------------------------------------------------------
/** This function returns a widget by name if that widget is found.
* \param name The name of the widget to find
* \return The result of the search, or NULL if the object is not found */
Widget* AbstractTopLevelContainer::getWidget(const char* name) Widget* AbstractTopLevelContainer::getWidget(const char* name)
{ {
return getWidget(name, &m_widgets); return getWidget(name, &m_widgets);
@ -122,6 +142,9 @@ Widget* AbstractTopLevelContainer::getWidget(const char* name)
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/** This function returns a widget by irrlicht ID if that widget is found.
* \param id The irrlicht ID of the widget to find
* \return The result of the search, or NULL if the object is not found */
Widget* AbstractTopLevelContainer::getWidget(const int id) Widget* AbstractTopLevelContainer::getWidget(const int id)
{ {
return getWidget(id, &m_widgets); return getWidget(id, &m_widgets);
@ -129,6 +152,10 @@ Widget* AbstractTopLevelContainer::getWidget(const int id)
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/** This function returns a widget by name if that widget is found in within_vector.
* \param name The name of the widget to find
* \param within_vector The vector of widgets to look in
* \return The result of the search, or NULL if the object is not found */
Widget* AbstractTopLevelContainer::getWidget(const char* name, Widget* AbstractTopLevelContainer::getWidget(const char* name,
PtrVector<Widget>* within_vector) PtrVector<Widget>* within_vector)
{ {
@ -145,13 +172,17 @@ Widget* AbstractTopLevelContainer::getWidget(const char* name,
Widget* el = getWidget(name, &(widget.m_children)); Widget* el = getWidget(name, &(widget.m_children));
if(el != NULL) return el; if(el != NULL) return el;
} }
} // next } // for n in all widgets
return NULL; return NULL;
} // getWidget } // getWidget
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/** This function returns a widget by irrlicht ID if that widget is found.
* \param id The irrlicht ID of the widget to find
* \param within_vector The vector to look into
* \return The result of the search, or NULL if the object is not found */
Widget* AbstractTopLevelContainer::getWidget(const int id, Widget* AbstractTopLevelContainer::getWidget(const int id,
PtrVector<Widget>* within_vector) PtrVector<Widget>* within_vector)
{ {
@ -173,13 +204,16 @@ Widget* AbstractTopLevelContainer::getWidget(const int id,
Widget* el = getWidget(id, &(widget.m_children)); Widget* el = getWidget(id, &(widget.m_children));
if(el != NULL) return el; if(el != NULL) return el;
} }
} // next } // for n in all widgets
return NULL; return NULL;
} // getWidget } // getWidget
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/** This function returns the first widget found in within_vector.
* \param within_vector The vector to look into
* \return The result of the search, or NULL if the object is not found */
Widget* AbstractTopLevelContainer::getFirstWidget( Widget* AbstractTopLevelContainer::getFirstWidget(
PtrVector<Widget>* within_vector) PtrVector<Widget>* within_vector)
{ {
@ -211,12 +245,15 @@ Widget* AbstractTopLevelContainer::getFirstWidget(
} }
return item; return item;
} } // for i in all widgets of within_vector
return NULL; return NULL;
} // getFirstWidget } // getFirstWidget
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
/** This function returns the last widget found in within_vector.
* \param within_vector The vector to look into
* \return The result of the search, or NULL if the object is not found */
Widget* AbstractTopLevelContainer::getLastWidget( Widget* AbstractTopLevelContainer::getLastWidget(
PtrVector<Widget>* within_vector) PtrVector<Widget>* within_vector)
{ {
@ -248,15 +285,16 @@ Widget* AbstractTopLevelContainer::getLastWidget(
} }
return item; return item;
} } // for i in all widgets of within_vector
return NULL; return NULL;
} // getLastWidget } // getLastWidget
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
/** /** This function is called when screen is removed. This means all irrlicht
* Called when screen is removed. This means all irrlicht widgets this object has pointers * widgets this object has pointers to are now gone. All references are set
* to are now gone. Set all references to NULL to avoid problems. * to NULL to avoid problems.
* \param within_vector The vector of widgets to clear
*/ */
void AbstractTopLevelContainer::elementsWereDeleted(PtrVector<Widget>* within_vector) void AbstractTopLevelContainer::elementsWereDeleted(PtrVector<Widget>* within_vector)
{ {

60
src/guiengine/abstract_top_level_container.hpp
View File

@ -18,11 +18,13 @@
#ifndef __TOP_LEVEL_CONT_HPP__ #ifndef __TOP_LEVEL_CONT_HPP__
#define __TOP_LEVEL_CONT_HPP__ #define __TOP_LEVEL_CONT_HPP__
#include <cstring> // for NULL
#include <typeinfo> // for typeid
#include "utils/ptr_vector.hpp"
#include "guiengine/widget.hpp" #include "guiengine/widget.hpp"
#include "utils/ptr_vector.hpp"
#include <cstring> // for NULL
#include <typeinfo> // for typeid
namespace GUIEngine namespace GUIEngine
{ {
@ -39,7 +41,7 @@ namespace GUIEngine
{ {
protected: protected:
/** the widgets in this screen */ /** the widgets in this screen */
PtrVector<Widget, HOLD> m_widgets; PtrVector<Widget, HOLD> m_widgets;
/** /**
* AbstractTopLevelContainer is generally able to determine its first * AbstractTopLevelContainer is generally able to determine its first
@ -47,7 +49,7 @@ namespace GUIEngine
* kart selection) you can help it by providing the first widget * kart selection) you can help it by providing the first widget
* manually. * manually.
*/ */
Widget* m_first_widget; Widget* m_first_widget;
/** /**
* AbstractTopLevelContainer is generally able to determine its last * AbstractTopLevelContainer is generally able to determine its last
@ -55,27 +57,31 @@ namespace GUIEngine
* kart selection) you can help it by providing the first widget * kart selection) you can help it by providing the first widget
* manually. * manually.
*/ */
Widget* m_last_widget; Widget* m_last_widget;
void addWidgetsRecursively(PtrVector<Widget>& widgets, void addWidgetsRecursively(PtrVector<Widget>& widgets,
Widget* parent=NULL); Widget* parent=NULL);
public: public:
AbstractTopLevelContainer(); AbstractTopLevelContainer();
virtual ~AbstractTopLevelContainer() {} virtual ~AbstractTopLevelContainer() {}
virtual int getWidth() = 0; virtual int getWidth() = 0;
virtual int getHeight() = 0; virtual int getHeight() = 0;
/** \return an object by name, or NULL if not found */ /** \return an object by name, or NULL if not found */
Widget* getWidget(const char* name); Widget* getWidget(const char* name);
/** \return an object by irrlicht ID, or NULL if not found */ /** \return an object by irrlicht ID, or NULL if not found */
Widget* getWidget(const int id); Widget* getWidget(const int id);
/** \return an object by name, casted to specified type, or NULL if /** This function searches and returns a widget by name, cast as specified type,
* if that widget is found and the type is correct.
* \param name The name of the widget to find
* \return an object by name, casted to specified type, or NULL if
* not found/wrong type */ * not found/wrong type */
template <typename T> T* getWidget(const char* name) template <typename T>
T* getWidget(const char* name)
{ {
Widget* out = getWidget(name); Widget* out = getWidget(name);
T* outCasted = dynamic_cast<T*>( out ); T* outCasted = dynamic_cast<T*>( out );
@ -89,17 +95,17 @@ namespace GUIEngine
return outCasted; return outCasted;
} }
static Widget* getWidget(const char* name, static Widget* getWidget(const char* name,
PtrVector<Widget>* within_vector); PtrVector<Widget>* within_vector);
static Widget* getWidget(const int id, static Widget* getWidget(const int id,
PtrVector<Widget>* within_vector); PtrVector<Widget>* within_vector);
Widget* getFirstWidget(PtrVector<Widget>* within_vector=NULL); Widget* getFirstWidget(PtrVector<Widget>* within_vector=NULL);
Widget* getLastWidget(PtrVector<Widget>* within_vector=NULL); Widget* getLastWidget(PtrVector<Widget>* within_vector=NULL);
void elementsWereDeleted(PtrVector<Widget>* within_vector = NULL);
void elementsWereDeleted(PtrVector<Widget>* within_vector = NULL); bool isMyChild(Widget* widget) const;
bool isMyChild(Widget* widget) const;
}; // AbstractTopLevelContainer }; // AbstractTopLevelContainer
} // namespace GUIEngine } // namespace GUIEngine