Program: bbtk
Module: $RCSfile: bbtkWxBlackBox.h,v $
Language: C++
- Date: $Date: 2008/01/22 15:02:00 $
- Version: $Revision: 1.1 $
+ Date: $Date: 2008/04/18 12:59:16 $
+ Version: $Revision: 1.11 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
#include "bbtkWx.h"
-#include "bbtkUserBlackBox.h"
+#include "bbtkAtomicBlackBox.h"
namespace bbtk
//==================================================================
/// Widget black boxes
- class BBTK_EXPORT WxBlackBox : public bbtk::UserBlackBox
- {
- BBTK_USER_BLACK_BOX_INTERFACE(WxBlackBox,bbtk::UserBlackBox);
+ class BBTK_EXPORT WxBlackBox : public bbtk::AtomicBlackBox
+ {
+ 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(WinDialog,bool);
BBTK_DECLARE_INPUT(WinHide,Void);
BBTK_DECLARE_OUTPUT(Widget, wxWindow*);//WxBlackBoxWidget*);
- BBTK_PROCESS(Process);
public:
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*);
+ /// 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();
- static void bbGlobalIncNbWindowsAlive() { bbmgNbWindowsAlive++; }
- static void bbGlobalDecNbWindowsAlive();
- static int bbGlobalGetNbWindowsAlive() { return bbmgNbWindowsAlive; }
- static bool bbGlobalIsSomeWindowAlive() { return (bbmgNbWindowsAlive>0);}
+ /// Returns the parent wxWindow that must be used to create the widget
+ wxWindow* bbGetWxParent();
- static void bbGlobalDecNbWindowsShown();
- static void bbGlobalIncNbWindowsShown() { bbmgNbWindowsShown++; }
- static int bbGlobalGetNbWindowsShown() { return bbmgNbWindowsShown; }
- static bool bbGlobalIsSomeWindowShown() { return (bbmgNbWindowsShown>0);}
+ /// Returns true iff the 'containing window' exists and is shown
+ /// (see bbGetContainingWindow).
+ bool bbIsShown();
-
- private:
- static wxWindow* bbmgTopWindow;
- static int bbmgNbWindowsAlive;
- static int bbmgNbWindowsShown;
+ //==================================================================
+ /// User callback invoked when the containing window is shown
+ virtual void bbUserOnShow() {}
+ //==================================================================
+
+ //==================================================================
+ /// User callback invoked when the containing window is hidden
+ virtual void bbUserOnHide() {}
+ //==================================================================
protected:
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 **
+ virtual void bbUserCreateWidget()
{
- 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 ?!?");
}
//==================================================================
- */
+
+
+
//==================================================================
- /// 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();
+ //==================================================================
private:
/// friendship
void bbInitAttributes();
+ protected :
+ /// 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 (the container window must be created and displayed - this box will be also executed by the normal pipeline recursion mechanism)
+ virtual void bbExecute(bool force = false);
};
//=================================================================
+ //======================================================================
+ /// Defines the bbUserCreateWidget method
+#define BBTK_CREATE_WIDGET(CALLBACK) \
+ public: \
+ inline void bbUserCreateWidget() \
+ { \
+ bbtkDebugMessageInc("Process",1,"=> "<<bbGetTypeName()<<"::bbUserCreateWidget() [" \
+ <<bbGetFullName()<<"]"<<std::endl); \
+ CALLBACK(); \
+ bbtkDebugMessageDec("Process",1,"<= "<<bbGetTypeName()<<"::bbUserCreateWidget() [" \
+ <<bbGetFullName()<<"]"<<std::endl); \
+ }
+
+ //======================================================================
+
//=================================================================
- // UserBlackBox description
- BBTK_BEGIN_DESCRIBE_BLACK_BOX(WxBlackBox,bbtk::UserBlackBox);
+ // WxBlackBoxDescriptor declaration
+ BBTK_BEGIN_DESCRIBE_BLACK_BOX(WxBlackBox,bbtk::AtomicBlackBox);
BBTK_NAME("WxBlackBox");
- // BBTK_INPUT_NOCOPY(WxBlackBox,WinParent,"Parent widget box",
- // WxParentToChildData*);
+ // 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 (only used if the box is the top window of a Parent-Child hierarchy)",
- std::string);
+ "Title of the window (*)",
+ std::string,"");
BBTK_INPUT(WxBlackBox,WinWidth,
- "Width of the window (only used if the box is the top window of a Parent-Child hierarchy)",int);
+ "Width of the window (* : only used if the widget is not inserted in another widget)",int,"");
BBTK_INPUT(WxBlackBox,WinHeight,
- "Height of the window (only used if the box is the top window of a Parent-Child hierarchy)",int);
+ "Height of the window (*)",int,"");
BBTK_INPUT(WxBlackBox,WinDialog,
- "Set to 'true' to have a dialog window, i.e. which is modal (steals the focus until closed) (only used if the box is the top window of a Parent-Child hierarchy)",bool);
+ "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 (only active if the box is the top window of a Parent-Child hierarchy)",Void);
- BBTK_OUTPUT(WxBlackBox,Widget,"Output widget",wxWindow*);
+ "Any signal received hides the window (*)",Void,"");
+ BBTK_OUTPUT(WxBlackBox,Widget,"Output widget",wxWindow*,"");
BBTK_END_DESCRIBE_BLACK_BOX(WxBlackBox);
//=================================================================
class BBTK_EXPORT WxBlackBoxWindow //: public wxWindow
{
public:
- WxBlackBoxWindow(WxBlackBox* box);
+ WxBlackBoxWindow(WxBlackBox::Pointer box);
virtual ~WxBlackBoxWindow();
virtual void bbShow();
virtual void bbHide();
bool bbIsShown() { return mShown; }
- virtual WxBlackBox* bbGetBlackBox() { return mBox; }
+ virtual WxBlackBox::Pointer bbGetBlackBox() { return mBox; }
virtual wxDialog* bbGetDialog() { return 0; }
virtual wxFrame* bbGetFrame() { return 0; }
private:
- WxBlackBox* mBox;
+ WxBlackBox::Pointer mBox;
bool mShown;
};
//==================================================================
class BBTK_EXPORT WxBlackBoxDialog : public wxDialog, public WxBlackBoxWindow
{
public:
- WxBlackBoxDialog(WxBlackBox* box,
+ WxBlackBoxDialog(WxBlackBox::Pointer box,
wxWindow *parent, wxString title, wxSize size);
~WxBlackBoxDialog();
void bbShow();
class BBTK_EXPORT WxBlackBoxFrame : public wxFrame, public WxBlackBoxWindow
{
public:
- WxBlackBoxFrame(WxBlackBox* box,
+ WxBlackBoxFrame(WxBlackBox::Pointer box,
wxWindow *parent, wxString title, wxSize size);
~WxBlackBoxFrame();
void bbShow();
//==================================================================
- /*
- //=================================================================
- /// Class from which a user defined widget associated to a WxBlackBox
- /// should inherit
- class BBTK_EXPORT WxBlackBoxWidget
- {
- public:
- /// Ctor with the WxBlackBox which created it
- WxBlackBoxWidget( WxBlackBox* box);
- /// Dtor
- virtual ~WxBlackBoxWidget();
-
- /// Returns the WxBlackBox which created it
- WxBlackBox* GetBlackBox() { return mBox; }
- /// Returns the WxBlackBox which created it (const)
- const WxBlackBox* GetBlackBox() const { return mBox; }
-
- /// Returns the wxWindow associated to the widget
- virtual wxWindow* GetWxWindow() { return 0; }
-
- virtual bool IsDead() { return false; }
-
- private:
- WxBlackBox* mBox;
- };
- //=================================================================
- */
//=================================================================
// Handles the destroy events of a widget associated to a WxBlackBox
{
public:
/// Ctor with the box and widget
- WxBlackBoxWidgetEventHandler( WxBlackBox* box, wxWindow *widget );
+ WxBlackBoxWidgetEventHandler( WxBlackBox::Pointer box, wxWindow *widget );
/// Dtor
~WxBlackBoxWidgetEventHandler();
/// Returns true iff is the handler for that window
//bool IsDead() { return mDead; }
private:
- WxBlackBox* mBox;
+ WxBlackBox::Pointer mBox;
wxWindow* mWindow;
//bool mDead;
};
//=================================================================
- /*
- //=================================================================
- /// A WxBlackBoxWidget which is a wxPanel also
- class BBTK_EXPORT WxBlackBoxWidgetPanel :
- public wxPanel,
- public WxBlackBoxWidget
-// public WxBlackBoxWidget,
-// public wxPanel
- {
- public:
- /// Ctor with the parent and the WxBlackBox which created it
- WxBlackBoxWidgetPanel(WxBlackBox* box, wxWindow *parent)
- :
- wxPanel( parent, -1, wxDefaultPosition, wxDefaultSize, wxTAB_TRAVERSAL),
- WxBlackBoxWidget(box)
- {}
-
- /// Returns the top panel of the widget
- wxWindow* GetWxWindow() { return (wxWindow*)(wxPanel*)(this); }
- /// Returns the top panel of the widget
- wxPanel* GetPanel() { return (wxPanel*)(this); }
-
- };
- //=================================================================
- */
} //namespace bbtk
git://git.creatis.insa-lyon.fr / bbtk.git / blobdiff