packages/kw/src/bbkwLayoutSplit.h

   1 /*=========================================================================
   2   Program:   bbtk
   3   Module:    $RCSfile: bbkwLayoutSplit.h,v $
   4   Language:  C++
   5   Date:      $Date: 2008/12/03 13:35:27 $
   6   Version:   $Revision: 1.3 $
   7 =========================================================================*/
   8
   9 /* ---------------------------------------------------------------------
  10
  11 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
  12 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
  13 *
  14 *  This software is governed by the CeCILL-B license under French law and
  15 *  abiding by the rules of distribution of free software. You can  use,
  16 *  modify and/ or redistribute the software under the terms of the CeCILL-B
  17 *  license as circulated by CEA, CNRS and INRIA at the following URL
  18 *  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  19 *  or in the file LICENSE.txt.
  20 *
  21 *  As a counterpart to the access to the source code and  rights to copy,
  22 *  modify and redistribute granted by the license, users are provided only
  23 *  with a limited warranty  and the software's author,  the holder of the
  24 *  economic rights,  and the successive licensors  have only  limited
  25 *  liability.
  26 *
  27 *  The fact that you are presently reading this means that you have had
  28 *  knowledge of the CeCILL-B license and that you accept its terms.
  29 * ------------------------------------------------------------------------ */
  30
  31
  32 /**
  33  */
  34 /**
  35  * \file
  36  * \brief Widget which splits a window into two parts
  37  */
  38 /**
  39  * \class bbkw::LayoutSplit
  40  * \brief Widget which splits a window into two parts
  41  */
  42
  43
  44 #ifdef USE_KWWIDGETS
  45
  46
  47 #ifndef __bbKwLayoutSplit_h__
  48 #define __bbKwLayoutSplit_h__
  49
  50 #include "bbtkKWBlackBox.h"
  51
  52 namespace bbkw
  53 {
  54
  55
  56
  57
  58   class LayoutSplit : public bbtk::KWBlackBox
  59   {
  60
  61     BBTK_BLACK_BOX_INTERFACE(LayoutSplit,bbtk::KWBlackBox);
  62     BBTK_DECLARE_INPUT(Widget1,vtkKWWidget*);
  63     BBTK_DECLARE_INPUT(Widget2,vtkKWWidget*);
  64     BBTK_DECLARE_INPUT(Orientation,std::string);
  65     BBTK_DECLARE_INPUT(Proportion,int);
  66     BBTK_PROCESS(Process);
  67     BBTK_CREATE_KWWIDGET(CreateWidget);
  68    void CreateWidget(vtkKWFrame*);
  69
  70     void Process();
  71   protected:
  72     virtual void bbUserConstructor();
  73
  74   };
  75
  76
  77 //=================================================================
  78 // BlackBox description
  79   BBTK_BEGIN_DESCRIBE_BLACK_BOX(LayoutSplit,bbtk::KWBlackBox);
  80   BBTK_NAME("kwLayoutSplit");
  81   BBTK_AUTHOR("laurent.guigues@creatis.insa-lyon.fr");
  82   BBTK_DESCRIPTION("Widget which splits a window in two fixed size parts (vtkKWSplitFrame)");
  83   // Already inserted for any KwBlackBox  BBTK_CATEGORY("widget");
  84   BBTK_INPUT(LayoutSplit,Widget1,"Upper or left widget",vtkKWWidget*,"");
  85   BBTK_INPUT(LayoutSplit,Widget2,"Lower or right widget",vtkKWWidget*,"");
  86   BBTK_INPUT(LayoutSplit,Orientation,"Orientation (default H), 0=H=HORIZONTAL , 1=V=VERTICAL",std::string,"");
  87    BBTK_INPUT(LayoutSplit,Proportion,"Proportion (in percent) of the first children in the window",int,"");
  88   BBTK_END_DESCRIBE_BLACK_BOX(LayoutSplit);
  89   //=================================================================
  90 }
  91
  92 //namespace bbtk
  93 #endif  //__bbtkKwLayoutSplit_h__
  94
  95 #endif //_USE_KWWIDGETS_