/***************************************************************************
                          SIMPLY POWERFUL TOOLKIT (SPTK)
                          cgroup.h  -  description
                             -------------------
    begin                : Sun May 22 2003
    copyright            : (C) 2000-2005 by Alexey S.Parshin
    email                : alexeyp@gmail.com
 ***************************************************************************/

/***************************************************************************
   This library is free software; you can redistribute it and/or modify it 
   under the terms of the GNU Library General Public License as published by
   the Free Software Foundation; either version 2 of the License, or (at 
   your option) any later version.

   This library 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 Library
   General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; if not, write to the Free Software Foundation, 
   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.

   Please report all bugs and problems to "alexeyp@gmail.com"
 ***************************************************************************/

#ifndef __CGROUP_H__
#define __CGROUP_H__

#include <FL/Fl_Group.H>
#include <sptk3/CStrings.h>
#include <sptk3/CLayoutClient.h>
#include <sptk3/CLayoutManager.h>

/// @addtogroup gui GUI Classes
/// @{

/// @brief SPTK group widget.
///
/// Extended version of FLTK Fl_Group that can be a layout manager and layout client
/// at the same time.
class CGroup : public Fl_Group, public CLayoutClient, public CLayoutManager {
protected:
   std::string m_label;        ///< Group' label
   Fl_Boxtype  m_outerFrame;   ///< Outer frame type
   Fl_Boxtype  m_innerFrame;   ///< Inner frame type
   bool        m_drawClipped;  ///< Draw the contens of the group clipped inside the group

   /// Computes the frame width for m_outerFrame and m_innerFrame
   int frameWidth() const;

   /// Constructor initializer
   /// @param label const char *, label
   void ctor_init(const char *label);

public:

   /// Constructor in SPTK style 
   /// @param label const char *, label
   /// @param layoutSize int, widget align in layout
   /// @param layoutAlign CLayoutAlign, widget align in layout
   CGroup(const char * label=0,int layoutSize=10,CLayoutAlign layoutAlign=SP_ALIGN_TOP);

#ifdef __COMPATIBILITY_MODE__    
   /// Constructor in FLTK style 
   /// @param x int, x-position
   /// @param y int, y-position
   /// @param w int, width
   /// @param h int, height
   /// @param label, const char * label
   CGroup(int x,int y,int w,int h,const char *label=0L);
#endif    

   /// Draws the group
   virtual void draw();

   /// Resizes the group and inside widgets. 
   /// @param x int, x-position
   /// @param y int, y-position
   /// @param w int, width
   /// @param h int, height
   virtual void resize(int x,int y,int w,int h);

   /// Computes the optimal group size
   /// @param w int&, input - width offered by the program, output - width required by widget
   /// @param h int&, input - height offered by the program, output - height required by widget
   virtual void preferredSize(int& w,int& h);

   /// Show or hide frame around it
   void frame(Fl_Boxtype outerFrame,Fl_Boxtype innerFrame);

   /// Sets label for the group, makes an internal copy of the string
   /// @param l const char *, label string
   void label(const char *l) { m_label = l; Fl_Group::label(m_label.c_str()); }

   /// Returns group label
   const char * label() const { return m_label.c_str(); }
};

/// @}

#endif
