X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkWxBlackBox.h;h=7c9db44300ea4d3e09786e367db368c8625c3c43;hb=8dd53a72bc1dd1ca2c6e2763c0aeb51c77ee352e;hp=095553d59b3023405e39e47016feb01dd4b704d7;hpb=97b08ef9b0c2a60c4d1f619f6bfef2996afdcab3;p=bbtk.git diff --git a/kernel/src/bbtkWxBlackBox.h b/kernel/src/bbtkWxBlackBox.h index 095553d..7c9db44 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/07/24 14:37:06 $ - Version: $Revision: 1.17 $ - - 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: 2009/05/14 14:43:34 $ + Version: $Revision: 1.27 $ +========================================================================*/ + + +/* --------------------------------------------------------------------- + +* 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 @@ -30,7 +44,7 @@ */ -#ifdef _USE_WXWIDGETS_ +#ifdef USE_WXWIDGETS #ifndef __bbtkWxBlackBox_h__ @@ -38,7 +52,7 @@ #include "bbtkWx.h" -#include "bbtkAtomicBlackBox.h" +#include "bbtkWidgetBlackBox.h" namespace bbtk @@ -47,10 +61,6 @@ namespace bbtk - //================================================================== - // Forward declaration of the class of window associated to a WxBlackBox - class WxBlackBoxWindow; - //================================================================== //================================================================== // Forward declaration of the widget event handler class @@ -60,185 +70,72 @@ namespace bbtk //================================================================== /// Widget black boxes - class BBTK_EXPORT WxBlackBox : public bbtk::AtomicBlackBox + class BBTK_EXPORT WxBlackBox : public bbtk::WidgetBlackBox { - BBTK_BLACK_BOX_INTERFACE(WxBlackBox,bbtk::AtomicBlackBox); - // BBTK_DECLARE_INPUT(WinParent,WxParentToChildData*); - 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, wxWindow*);//WxBlackBoxWidget*); - 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 **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 the parent wxWindow that must be used to create the widget - 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() {} - //================================================================== + BBTK_BLACK_BOX_INTERFACE(WxBlackBox,bbtk::WidgetBlackBox); - protected: + + // protected: + public: - //================================================================== - /// User callback called in the box contructor - virtual void bbUserConstructor(); - /// User callback called in the box copy constructor - virtual void bbUserCopyConstructor(); - /// User callback called in the box destructor - virtual void bbUserDestructor(); + //================================================================== + /// Callback for creating a Dialog window (modal) + /// ** Must be defined ** in toolkit specific descendants + virtual void bbCreateDialogWindow(); //================================================================== //================================================================== - /// User callback for creating the widget associated to the box - /// ** Must be defined ** - virtual void bbUserCreateWidget() - { - bbtkError(bbGetTypeName()<<" is a WxBlackBox whose bbUserCreateWidget methods is not overloaded : is it a feature or a bug ?!?"); - } + /// Callback for creating a Frame window + /// ** Must be defined ** in toolkit specific descendants + virtual void bbCreateFrameWindow(); //================================================================== - - - + + //================================================================== - /// Main processing method of the box. - virtual IOStatus bbBackwardUpdate( Connection::Pointer caller ); + // virtual void InitWindowManagerIfNeeded(); + virtual void IncNbWindowsAlive(); + virtual void DecNbWindowsAlive(); + virtual int GetNbWindowsAlive(); + virtual bool IsSomeWindowAlive(); + + virtual void IncNbWindowsShown(); + virtual void DecNbWindowsShown(); + virtual int GetNbWindowsShown(); + virtual bool IsSomeWindowShown(); //================================================================== - - //================================================================== - /// 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(); - //================================================================== + + //================================================================== + void bbCreateWidgetAndEventHandler(wxWindow* parent); + //================================================================== + + //================================================================== private: /// friendship - friend class WxBlackBoxWindow; friend class WxBlackBoxWidgetEventHandler; - - /// Sets the window - inline void bbSetWindow(Window* w) { bbmWindow=w; } - /// Sets the Widget Event Handler inline void bbSetWidgetEventHandler(WxBlackBoxWidgetEventHandler* w) { bbmWidgetEventHandler = w; } /// Gets the Widget Event Handler inline WxBlackBoxWidgetEventHandler* bbGetWidgetEventHandler() { return bbmWidgetEventHandler; } - - - /// The WxBlackBoxWindow associated to the box - Window* bbmWindow; /// The WxBlackBoxWidgetEventHandler associated to the box WxBlackBoxWidgetEventHandler* bbmWidgetEventHandler; - - - 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() \ - { \ - bbtkDebugMessageInc("process",1,"**> Creating widget for [" \ - < + BBTK_BEGIN_DESCRIBE_BLACK_BOX_BODY(WxBlackBox); BBTK_NAME("WxBlackBox"); - // BBTK_DESCRIPTION("Widget box. The inputs marked with (*) are only used if the widget is not inserted in another widget.\n"); - BBTK_CATEGORY("widget"); - BBTK_INPUT(WxBlackBox,WinTitle, - "Title of the window (*)", - std::string,""); - BBTK_INPUT(WxBlackBox,WinWidth, - "Width of the window (* : only used if the widget is not connected to a Layout box)",int,""); - BBTK_INPUT(WxBlackBox,WinHeight, - "Height of the window (*)",int,""); - BBTK_INPUT(WxBlackBox,WinDialog, - "Set to 'true' to create a dialog window, i.e. which blocks the pipeline until it is closed (modal) (*)",bool,""); - BBTK_INPUT(WxBlackBox,WinHide, - "Any signal received hides the window (*)",Void,"signal"); - BBTK_INPUT(WxBlackBox,WinClose, - "Any signal received closes the window (*)",Void,"signal"); - BBTK_OUTPUT(WxBlackBox,Widget,"Output widget",wxWindow*,""); BBTK_END_DESCRIBE_BLACK_BOX(WxBlackBox); //================================================================= @@ -250,52 +147,41 @@ namespace bbtk - //================================================================== - // The base of the hierarchy of windows associated to a WxBlackBox - class BBTK_EXPORT WxBlackBoxWindow //: public wxWindow - { - public: - WxBlackBoxWindow(WxBlackBox::Pointer box); - virtual ~WxBlackBoxWindow(); - virtual void bbShow(); - virtual void bbHide(); - virtual void bbClose(); - bool bbIsShown() { return mShown; } - virtual WxBlackBox::Pointer bbGetBlackBox() { return mBox.lock(); } - virtual wxDialog* bbGetDialog() { return 0; } - virtual wxFrame* bbGetFrame() { return 0; } - private: - WxBlackBox::WeakPointer mBox; - bool mShown; - }; - //================================================================== //================================================================== // Dialog window which is modal - class BBTK_EXPORT WxBlackBoxDialog : public wxDialog, public WxBlackBoxWindow + class BBTK_EXPORT WxBlackBoxDialog : public wxDialog, + public WidgetBlackBoxWindow { public: + typedef WidgetBlackBoxWindow Parent; WxBlackBoxDialog(WxBlackBox::Pointer box, wxWindow *parent, wxString title, wxSize size); ~WxBlackBoxDialog(); void bbShow(); void bbHide(); void bbClose(); + bool IsDialog() { return true; } + bool IsFrame() { return false; } wxDialog* bbGetDialog() { return this; } }; //================================================================== //================================================================== // Frame window which is not modal - class BBTK_EXPORT WxBlackBoxFrame : public wxFrame, public WxBlackBoxWindow + class BBTK_EXPORT WxBlackBoxFrame : public wxFrame, + public WidgetBlackBoxWindow { public: + typedef WidgetBlackBoxWindow Parent; WxBlackBoxFrame(WxBlackBox::Pointer box, wxWindow *parent, wxString title, wxSize size); ~WxBlackBoxFrame(); void bbShow(); void bbHide(); void bbClose(); + bool IsDialog() { return false; } + bool IsFrame() { return true; } wxFrame* bbGetFrame() { return this; } }; //================================================================== @@ -333,4 +219,4 @@ namespace bbtk #endif //__bbtkWxBlackBox_h__ -#endif //_USE_WXWIDGETS_ +#endif //USE_WXWIDGETS