X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkWxBlackBox.h;h=e2857e0d47c57d0f87ce4d0b548272b77bbb138a;hb=1e2df7fb6ae571ce1cf72e6af1715f0e34675cbf;hp=5ff5d6644b4d350503e8d448b48d1ff2b014fce3;hpb=a26195c366a89795288009cf7e20f11afa494970;p=bbtk.git diff --git a/kernel/src/bbtkWxBlackBox.h b/kernel/src/bbtkWxBlackBox.h index 5ff5d66..e2857e0 100644 --- a/kernel/src/bbtkWxBlackBox.h +++ b/kernel/src/bbtkWxBlackBox.h @@ -1,20 +1,34 @@ -/*========================================================================= - +/*========================================================================= Program: bbtk Module: $RCSfile: bbtkWxBlackBox.h,v $ Language: C++ - Date: $Date: 2008/01/22 15:02:00 $ - Version: $Revision: 1.1 $ - - Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de - l'Image). All rights reserved. See Doc/License.txt or - http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details. - - This software is distributed WITHOUT ANY WARRANTY; without even - the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR - PURPOSE. See the above copyright notices for more information. - -=========================================================================*//** + Date: $Date: 2008/11/25 11:17:13 $ + Version: $Revision: 1.21 $ +========================================================================*/ + + +/* --------------------------------------------------------------------- + +* 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 @@ -38,7 +52,7 @@ #include "bbtkWx.h" -#include "bbtkUserBlackBox.h" +#include "bbtkAtomicBlackBox.h" namespace bbtk @@ -60,50 +74,61 @@ namespace bbtk //================================================================== /// Widget black boxes - class BBTK_EXPORT WxBlackBox : public bbtk::UserBlackBox - { - BBTK_USER_BLACK_BOX_INTERFACE(WxBlackBox,bbtk::UserBlackBox); - // BBTK_DECLARE_INPUT(WinParent,WxParentToChildData*); + class BBTK_EXPORT WxBlackBox : public bbtk::AtomicBlackBox + { + BBTK_BLACK_BOX_INTERFACE(WxBlackBox,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_OUTPUT(Widget, wxWindow*);//WxBlackBoxWidget*); - BBTK_PROCESS(Process); + BBTK_DECLARE_INPUT(WinClose,Void); + BBTK_DECLARE_OUTPUT(Widget, wxWindow*); public: + /// Main processing method of the box. Overloaded to handle windows inclusion : if the output Widget is connected then the execution is transfered to the box to which it is connected (as the container window must be created and displayed - this box will be executed by the normal pipeline recursion mechanism) + virtual void bbExecute(bool force = false); + + typedef WxBlackBoxWindow Window; - /// Returns the window associated to the box + /// Returns the **OWN** window associated to the box /// If 0 returned = no window Window* bbGetWindow() { return bbmWindow; } - /// Returns the Parent Window that must be used to create the widget - wxWindow* bbGetWxParent() { return bbGlobalGetTopWindow(); } - - - /// Returns the global parent of all bbtk windows - static wxWindow* bbGlobalGetTopWindow(); - /// Sets the global parent of all bbtk windows - static void bbGlobalSetTopWindow(wxWindow*); - - static void bbGlobalIncNbWindowsAlive() { bbmgNbWindowsAlive++; } - static void bbGlobalDecNbWindowsAlive(); - static int bbGlobalGetNbWindowsAlive() { return bbmgNbWindowsAlive; } - static bool bbGlobalIsSomeWindowAlive() { return (bbmgNbWindowsAlive>0);} - - static void bbGlobalDecNbWindowsShown(); - static void bbGlobalIncNbWindowsShown() { bbmgNbWindowsShown++; } - static int bbGlobalGetNbWindowsShown() { return bbmgNbWindowsShown; } - static bool bbGlobalIsSomeWindowShown() { return (bbmgNbWindowsShown>0);} + /// 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 the parent wxWindow that must be used to create the widget + // + // LG 24/11/08 : New widget pipeline + // wxWindow* bbGetWxParent(); + + /// 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() {} + //================================================================== - private: - static wxWindow* bbmgTopWindow; - static int bbmgNbWindowsAlive; - static int bbmgNbWindowsShown; + // LG 24/11/08 : New widget pipeline + void bbCreateWidgetAndEventHandler(wxWindow* parent); + protected: @@ -111,46 +136,53 @@ namespace bbtk /// User callback called in the box contructor virtual void bbUserConstructor(); /// User callback called in the box copy constructor - virtual void bbUserCopyConstructor(); + virtual void bbUserCopyConstructor(bbtk::BlackBox::Pointer); /// User callback called in the box destructor virtual void bbUserDestructor(); //================================================================== - /* - - //================================================================== - /// User callback for creating the window associated to the box - /// Can be overloaded in order to impose your own window to show, - /// Typically if your widget is already a dialog that cannot - /// be inserted into a parent. - /// WARNING : If you use it then your widget will not be inserted - /// in the parent window, if any - /// (i.e. even if the Parent-Child connection is set) - virtual Window* bbUserCreateWindow() - { - return 0; - } - //================================================================== - //================================================================== /// User callback for creating the widget associated to the box - /// Must be defined if bbUserCreateWindow is not - virtual Widget* bbUserCreateWidget(wxWindow *parent) + /// ** Must be defined ** + // LG 24/11/08 : New widget pipeline + virtual void bbUserCreateWidget(wxWindow* parent) { - bbtkError(bbGetTypeName()<<" is a WxBlackBox whose bbUserCreateWindow and bbUserCreateWidget methods are both undefined : cannot work !!"); - return 0; + bbtkError(bbGetTypeName()<<" is a WxBlackBox whose bbUserCreateWidget methods is not overloaded : is it a feature or a bug ?!?"); } //================================================================== - */ + + + wxWindow* bbCreateWidgetOfInput(const std::string& in, wxWindow* parent); + //================================================================== - /// Specific methods for windows creation during pipeline execution - //void bbCreateWindow(); - void bbShowWindow(Connection* caller); - void bbHideWindow(); + /// Main processing method of the box. + virtual IOStatus bbBackwardUpdate( Connection::Pointer caller ); //================================================================== - void Process() { } + + + //================================================================== + /// Overloaded processing method for WxBlackBoxes : + /// 1) if the widget is null then + /// calls the user defined widget creation method : bbUserCreateWidget() + /// 2) calls the user defined processing method : bbUserProcess() + /// 3) displays the window : bbShowWindow(); + virtual void bbProcess(); + //================================================================== + + //================================================================== + /// If necessary creates the WxBlackBoxWindow 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 WxBlackBoxWindow associated to the box (if exists) + void bbHideWindow(); + /// Closes (destroys) the WxBlackBoxWindow associated to the box (if exists) + void bbCloseWindow(); + //================================================================== private: /// friendship @@ -176,29 +208,73 @@ namespace bbtk void bbInitAttributes(); + protected : + + + /// For Forward update mechanism when execution is called + /// on a contained window + /// Is set to true before transfering update to parent + /// in order to not re-transfer a second time... + bool bbmUpdateTransferedToParent; + + bool bbGetUpdateTransferedToParent() const { return bbmUpdateTransferedToParent; } + void bbSetUpdateTransferedToParent(bool b) + { bbmUpdateTransferedToParent = b; } }; //================================================================= + //====================================================================== + /// Defines the bbUserCreateWidget method +#define BBTK_CREATE_WIDGET(CALLBACK) \ + public: \ + inline void bbUserCreateWidget(wxWindow* parent) \ + { \ + bbtkDebugMessageInc("wx",1,"**> Creating widget for [" \ + < Showing [" \ + <