/*========================================================================= Program: bbtk Module: $RCSfile: bbtkKWBlackBox.h,v $ Language: C++ Date: $Date: 2008/12/11 09:50:35 $ Version: $Revision: 1.5 $ ========================================================================*/ /* --------------------------------------------------------------------- * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale) * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux * * This software is governed by the CeCILL-B license under French law and * abiding by the rules of distribution of free software. You can use, * modify and/ or redistribute the software under the terms of the CeCILL-B * license as circulated by CEA, CNRS and INRIA at the following URL * http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html * or in the file LICENSE.txt. * * As a counterpart to the access to the source code and rights to copy, * modify and redistribute granted by the license, users are provided only * with a limited warranty and the software's author, the holder of the * economic rights, and the successive licensors have only limited * liability. * * The fact that you are presently reading this means that you have had * knowledge of the CeCILL-B license and that you accept its terms. * ------------------------------------------------------------------------ */ /** * \brief Short description in one line * * Long description which * can span multiple lines */ /** * \file * \brief */ /** * \class bbtk:: * \brief */ #ifndef __bbtkKWBlackBox_h_INCLUDED__ #define __bbtkKWBlackBox_h_INCLUDED__ #ifdef USE_KWWIDGETS #include "bbtkAtomicBlackBox.h" #include "bbtkKW.h" //================================================================== // Forward declaration of the class of window associated to a KWBlackBox class vtkKWBlackBoxWindow; class vtkKWBlackBoxDialog; class vtkKWFrame; //================================================================== namespace bbtk { //================================================================== /// Widget black boxes class BBTK_EXPORT KWBlackBox : public bbtk::AtomicBlackBox { BBTK_BLACK_BOX_INTERFACE(KWBlackBox,bbtk::AtomicBlackBox); BBTK_DECLARE_INPUT(WinTitle,std::string); BBTK_DECLARE_INPUT(WinWidth,int); BBTK_DECLARE_INPUT(WinHeight,int); BBTK_DECLARE_INPUT(WinDialog,bool); BBTK_DECLARE_INPUT(WinHide,Void); BBTK_DECLARE_INPUT(WinClose,Void); BBTK_DECLARE_OUTPUT(Widget, vtkKWWidget*); public: typedef vtkKWBlackBoxDialog Window; /// Returns the **OWN** window associated to the box /// If 0 returned = no window Window* bbGetWindow() { return bbmWindow; } /// Returns the window containing the widget associated to the box /// Which can be the own window of **ANOTHER** box in case of /// a hierarchy of widgets. /// More precisely : /// If bbGetWindow() != 0 then returns bbGetWindow() /// Else if the output 'Widget' is connected /// then returns bbGetContainingWindow() of the box connected to 'Widget' /// Else returns 0; Window* bbGetContainingWindow(); /// Returns true iff the 'containing window' exists and is shown /// (see bbGetContainingWindow). bool bbIsShown(); //================================================================== /// User callback invoked when the containing window is shown virtual void bbUserOnShow() {} //================================================================== //================================================================== /// User callback invoked when the containing window is hidden virtual void bbUserOnHide() {} //================================================================== /// Sets the window inline void bbSetWindow(Window* w) { bbmWindow=w; } protected: //================================================================== /// User callback called in the box contructor virtual void bbUserConstructor(); /// User callback called in the box copy constructor virtual void bbUserCopyConstructor(bbtk::BlackBox::Pointer); /// User callback called in the box destructor virtual void bbUserDestructor(); //================================================================== //================================================================== /// User callback for creating the widget associated to the box /// ** Must be defined ** // LG 24/11/08 : New widget pipeline virtual void bbUserCreateWidget(vtkKWFrame* parent) { bbtkError(bbGetTypeName()<<" is a KWBlackBox whose bbUserCreateWidget methods is not overloaded : is it a feature or a bug ?!?"); } //================================================================== //================================================================== vtkKWWidget* bbCreateWidgetOfInput(const std::string& in, vtkKWFrame* parent); //================================================================== //================================================================== /// Overloaded processing method for KWBlackBoxes virtual void bbProcess(); //================================================================== //================================================================== /// If necessary creates the KWBlackBoxWindow associated to the box /// and shows it /// (does nothing if the box output 'Widget' is connected which /// means that the box does not have its own window but is contained /// into another window) void bbShowWindow(); /// Hides the KWBlackBoxWindow associated to the box (if exists) void bbHideWindow(); /// Closes (destroys) the KWBlackBoxWindow associated to the box (if exists) void bbCloseWindow(); //================================================================== private: /// friendship friend class vtkKWBlackBoxWindow; // friend class KWBlackBoxWidgetEventHandler; /// The KWBlackBoxWindow associated to the box Window* bbmWindow; void bbInitAttributes(); }; //================================================================= //====================================================================== /// Defines the bbUserCreateWidget method #define BBTK_CREATE_KWWIDGET(CALLBACK) \ public: \ inline void bbUserCreateWidget(vtkKWFrame* parent) \ { \ bbtkDebugMessageInc("kw",1,"**> Creating widget for [" \ < Showing [" \ <