Reorder class members

[libs/gltk.git] / source / root.h

diff --git a/source/root.h b/source/root.h
index 809780cf291829720cf328fd5bfe9604cf63b01b..863f1f781eaaf486ac0bb84d847f80ca34bd9033 100644 (file)
--- a/source/root.h
+++ b/source/root.h
@@ -1,3 +1,10 @@
+/* $Id$
+
+This file is part of libmspgltk
+Copyright © 2007  Mikko Rasa, Mikkosoft Productions
+Distributed under the LGPL
+*/
+
 #ifndef MSP_GLTK_ROOT_H_
 #define MSP_GLTK_ROOT_H_
 
@@ -7,13 +14,20 @@
 namespace Msp {
 namespace GLtk {
 
+/**
+A Root is a special type of Panel that covers and entire Window and accepts
+input from it.  When created, a Root widget will take its size from the window
+it is created for.  The size can be changed, but a Root should always be
+rendered to fill the window in order to get coordinates mapped correctly.
+*/
 class Root: public Panel
 {
-public:
-       Root(Resources &, Window &);
 private:
        Window &window;
 
+public:
+       Root(Resources &, Window &);
+private:
        const char *get_class() const { return "root"; }
        void button_press_event(int, int, unsigned, unsigned);
        void button_release_event(int, int, unsigned, unsigned);