bbtk::WxBlackBox Class Reference

Widget black boxes. More...

#include <bbtkWxBlackBox.h>

List of all members.

Public Types
typedef WxBlackBox	Self
typedef boost::shared_ptr< Self >	Pointer
typedef boost::weak_ptr< Self >	WeakPointer
typedef WxBlackBoxWindow	Window
Public Member Functions
std::string	GetObjectName () const
bbtk::BlackBox::Pointer	bbClone (const std::string &name)
virtual void	bbLockDescriptor ()
std::string	bbGetInputWinTitle ()
void	bbSetInputWinTitle (std::string d)
int	bbGetInputWinWidth ()
void	bbSetInputWinWidth (int d)
int	bbGetInputWinHeight ()
void	bbSetInputWinHeight (int d)
bool	bbGetInputWinDialog ()
void	bbSetInputWinDialog (bool d)
Void	bbGetInputWinHide ()
void	bbSetInputWinHide (Void d)
Void	bbGetInputWinClose ()
void	bbSetInputWinClose (Void d)
wxWindow *	bbGetOutputWidget ()
void	bbSetOutputWidget (wxWindow *d)
virtual void	bbExecute (bool force=false)
	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).
Window *	bbGetWindow ()
Window *	bbGetContainingWindow ()
wxWindow *	bbGetWxParent ()
	Returns the parent wxWindow that must be used to create the widget.
bool	bbIsShown ()
virtual void	bbUserOnShow ()
	User callback invoked when the containing window is shown.
virtual void	bbUserOnHide ()
	User callback invoked when the containing window is hidden.
Static Public Member Functions
static Pointer	New (const std::string &name)
Protected Member Functions
	WxBlackBox (const std::string &name, bool allocate_connectors=true)
	WxBlackBox (Self &from, const std::string &name, bool allocate_connectors=true)
	~WxBlackBox ()
virtual void	bbUserConstructor ()
	User callback called in the box contructor.
virtual void	bbUserCopyConstructor ()
	User callback called in the box copy constructor.
virtual void	bbUserDestructor ()
	User callback called in the box destructor.
virtual void	bbUserCreateWidget ()
virtual IOStatus	bbBackwardUpdate (Connection::Pointer caller)
	Main processing method of the box.
virtual void	bbProcess ()
void	bbShowWindow ()
void	bbHideWindow ()
	Hides the WxBlackBoxWindow associated to the box (if exists).
void	bbCloseWindow ()
	Closes (destroys) the WxBlackBoxWindow associated to the box (if exists).
bool	bbGetUpdateTransferedToParent () const
void	bbSetUpdateTransferedToParent (bool b)
Protected Attributes
std::string	bbmInputWinTitle
int	bbmInputWinWidth
int	bbmInputWinHeight
bool	bbmInputWinDialog
Void	bbmInputWinHide
Void	bbmInputWinClose
wxWindow *	bbmOutputWidget
bool	bbmUpdateTransferedToParent
Private Member Functions
	WxBlackBox ()
	WxBlackBox (const WxBlackBox &)
void	bbSetWindow (Window *w)
	Sets the window.
void	bbSetWidgetEventHandler (WxBlackBoxWidgetEventHandler *w)
	Sets the Widget Event Handler.
WxBlackBoxWidgetEventHandler *	bbGetWidgetEventHandler ()
	Gets the Widget Event Handler.
void	bbInitAttributes ()
	Initialize the attributes of the class.
Private Attributes
Window *	bbmWindow
	The WxBlackBoxWindow associated to the box.
WxBlackBoxWidgetEventHandler *	bbmWidgetEventHandler
	The WxBlackBoxWidgetEventHandler associated to the box.
Friends
struct	Object::Deleter
class	WxBlackBoxWindow
	friendship
class	WxBlackBoxWidgetEventHandler

---

Detailed Description

Widget black boxes.

Definition at line 77 of file bbtkWxBlackBox.h.

---

Member Typedef Documentation

typedef WxBlackBox bbtk::WxBlackBox::Self

Definition at line 79 of file bbtkWxBlackBox.h.

typedef boost::shared_ptr<Self> bbtk::WxBlackBox::Pointer

Definition at line 79 of file bbtkWxBlackBox.h.

typedef boost::weak_ptr<Self> bbtk::WxBlackBox::WeakPointer

Definition at line 79 of file bbtkWxBlackBox.h.

typedef WxBlackBoxWindow bbtk::WxBlackBox::Window

Definition at line 94 of file bbtkWxBlackBox.h.

---

Constructor & Destructor Documentation

bbtk::WxBlackBox::WxBlackBox	(	const std::string &	name,
		bool	allocate_connectors = true
	)			[protected]

Definition at line 344 of file bbtkWxBlackBox.cxx.

bbtk::WxBlackBox::WxBlackBox	(	Self &	from,
		const std::string &	name,
		bool	allocate_connectors = true
	)			[protected]

Definition at line 344 of file bbtkWxBlackBox.cxx.

bbtk::WxBlackBox::~WxBlackBox

(

)

[protected]

Definition at line 344 of file bbtkWxBlackBox.cxx.

bbtk::WxBlackBox::WxBlackBox

(

)

[inline, private]

Definition at line 79 of file bbtkWxBlackBox.h.

bbtk::WxBlackBox::WxBlackBox

(

const WxBlackBox &

)

[inline, private]

Definition at line 79 of file bbtkWxBlackBox.h.

---

Member Function Documentation

std::string bbtk::WxBlackBox::GetObjectName

(

)

const [inline]

Definition at line 79 of file bbtkWxBlackBox.h.

static Pointer bbtk::WxBlackBox::New

(

const std::string &

name

)

[inline, static]

Definition at line 79 of file bbtkWxBlackBox.h.

bbtk::BlackBox::Pointer bbtk::WxBlackBox::bbClone

(

const std::string &

name

)

[inline]

Definition at line 79 of file bbtkWxBlackBox.h.

void bbtk::WxBlackBox::bbLockDescriptor

(

)

[virtual]

Definition at line 344 of file bbtkWxBlackBox.cxx.

std::string bbtk::WxBlackBox::bbGetInputWinTitle

(

)

[inline]

Definition at line 81 of file bbtkWxBlackBox.h.

Referenced by bbShowWindow().

:

Here is the caller graph for this function:

void bbtk::WxBlackBox::bbSetInputWinTitle

(

std::string

d

)

[inline]

Definition at line 81 of file bbtkWxBlackBox.h.

Referenced by bbInitAttributes().

:

Here is the caller graph for this function:

int bbtk::WxBlackBox::bbGetInputWinWidth

(

)

[inline]

Definition at line 82 of file bbtkWxBlackBox.h.

Referenced by bbShowWindow().

:

Here is the caller graph for this function:

void bbtk::WxBlackBox::bbSetInputWinWidth

(

int

d

)

[inline]

Definition at line 82 of file bbtkWxBlackBox.h.

Referenced by bbInitAttributes().

:

Here is the caller graph for this function:

int bbtk::WxBlackBox::bbGetInputWinHeight

(

)

[inline]

Definition at line 83 of file bbtkWxBlackBox.h.

Referenced by bbShowWindow().

:

Here is the caller graph for this function:

void bbtk::WxBlackBox::bbSetInputWinHeight

(

int

d

)

[inline]

Definition at line 83 of file bbtkWxBlackBox.h.

Referenced by bbInitAttributes().

:

Here is the caller graph for this function:

bool bbtk::WxBlackBox::bbGetInputWinDialog

(

)

[inline]

Definition at line 84 of file bbtkWxBlackBox.h.

Referenced by bbShowWindow().

:

Here is the caller graph for this function:

void bbtk::WxBlackBox::bbSetInputWinDialog

(

bool

d

)

[inline]

Definition at line 84 of file bbtkWxBlackBox.h.

Referenced by bbInitAttributes().

:

Here is the caller graph for this function:

Void bbtk::WxBlackBox::bbGetInputWinHide

(

)

[inline]

Definition at line 85 of file bbtkWxBlackBox.h.

:

void bbtk::WxBlackBox::bbSetInputWinHide

(

Void

d

)

[inline]

Definition at line 85 of file bbtkWxBlackBox.h.

:

Void bbtk::WxBlackBox::bbGetInputWinClose

(

)

[inline]

Definition at line 86 of file bbtkWxBlackBox.h.

:

void bbtk::WxBlackBox::bbSetInputWinClose

(

Void

d

)

[inline]

Definition at line 86 of file bbtkWxBlackBox.h.

:

wxWindow* bbtk::WxBlackBox::bbGetOutputWidget

(

)

[inline]

Definition at line 87 of file bbtkWxBlackBox.h.

Referenced by bbProcess(), and bbShowWindow().

:

Here is the caller graph for this function:

void bbtk::WxBlackBox::bbSetOutputWidget

(

wxWindow *

d

)

[inline]

Definition at line 87 of file bbtkWxBlackBox.h.

Referenced by bbInitAttributes().

:

Here is the caller graph for this function:

void bbtk::WxBlackBox::bbExecute

(

bool

force = false

)

[virtual]

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).

Main processing method of the box.

Definition at line 419 of file bbtkWxBlackBox.cxx.

References bbtkDebugMessage, bbtkDebugMessageDec, bbtkDebugMessageInc, and bbtk::i.

  {
    bbtkDebugMessageInc("process",2,
                        "=> WxBlackBox::bbExecute() ["
                        <<bbGetFullName()<<"]"<<std::endl);

    // If the output 'Widget' is connected then 
    // we must execute the parent box
    BlackBox::OutputConnectorMapType::const_iterator i 
      = bbGetOutputConnectorMap().find("Widget");

    if ( i->second->GetConnectionVector().size() != 0 ) 
      {
        bbtkDebugMessage("process",3,
                         "-> Output 'Widget' connected : transfering execution to parent"
                         <<std::endl);
        
        i->second->GetConnectionVector().front() //.lock()
          ->GetBlackBoxTo()->bbExecute(force);

      }
    // else call 'standard' BlackBox execution method
    else 
      {
        BlackBox::bbExecute(force);
      }
    //

    bbtkDebugMessageDec("process",2,
                        "<= WxBlackBox::bbExecute() ["
                        <<bbGetFullName()<<"]"<<std::endl);
  }

Window* bbtk::WxBlackBox::bbGetWindow

(

)

[inline]

Returns the **OWN** window associated to the box If 0 returned = no window

Definition at line 98 of file bbtkWxBlackBox.h.

Referenced by bbCloseWindow(), bbGetContainingWindow(), bbHideWindow(), bbShowWindow(), and bbUserDestructor().

{ return bbmWindow; }

Here is the caller graph for this function:

WxBlackBox::Window * bbtk::WxBlackBox::bbGetContainingWindow

(

)

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;

Definition at line 704 of file bbtkWxBlackBox.cxx.

References bbGetContainingWindow(), bbGetWindow(), and bbtk::i.

Referenced by bbGetContainingWindow(), and bbIsShown().

  {
    if (bbGetWindow()!=0) return bbGetWindow();
    BlackBox::OutputConnectorMapType::const_iterator i 
      = bbGetOutputConnectorMap().find("Widget");
    if ( i->second->GetConnectionVector().size() != 0 ) 
      {
        return boost::static_pointer_cast<WxBlackBox>
          (i->second->GetConnectionVector().front() //.lock()
           ->GetBlackBoxTo())->bbGetContainingWindow();
      }
    return 0;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

wxWindow * bbtk::WxBlackBox::bbGetWxParent

(

)

Returns the parent wxWindow that must be used to create the widget.

Definition at line 721 of file bbtkWxBlackBox.cxx.

Referenced by bbShowWindow().

{ return Wx::GetTopWindow(); }

Here is the caller graph for this function:

bool bbtk::WxBlackBox::bbIsShown

(

)

Returns true iff the 'containing window' exists and is shown (see bbGetContainingWindow).

Definition at line 726 of file bbtkWxBlackBox.cxx.

References bbGetContainingWindow(), and bbtk::WxBlackBoxWindow::bbIsShown().

  {
    if (bbGetContainingWindow()!=0)
      return bbGetContainingWindow()->bbIsShown();
    return false;
  }

Here is the call graph for this function:

virtual void bbtk::WxBlackBox::bbUserOnShow

(

)

[inline, virtual]

User callback invoked when the containing window is shown.

Definition at line 119 of file bbtkWxBlackBox.h.

{}

virtual void bbtk::WxBlackBox::bbUserOnHide

(

)

[inline, virtual]

User callback invoked when the containing window is hidden.

Definition at line 124 of file bbtkWxBlackBox.h.

{}

void bbtk::WxBlackBox::bbUserConstructor

(

)

[protected, virtual]

User callback called in the box contructor.

Definition at line 348 of file bbtkWxBlackBox.cxx.

References bbInitAttributes(), and bbtkDebugMessage.

  {
    bbtkDebugMessage("Kernel",9,"WxBlackBox::bbUserConstructor()"<<std::endl);
    bbInitAttributes();
  }

Here is the call graph for this function:

void bbtk::WxBlackBox::bbUserCopyConstructor

(

)

[protected, virtual]

User callback called in the box copy constructor.

Definition at line 356 of file bbtkWxBlackBox.cxx.

References bbInitAttributes(), and bbtkDebugMessage.

  {
    bbtkDebugMessage("Kernel",9,"WxBlackBox::bbUserCopyConstructor()"
                     <<std::endl);
    bbInitAttributes();
  }

Here is the call graph for this function:

void bbtk::WxBlackBox::bbUserDestructor

(

)

[protected, virtual]

User callback called in the box destructor.

Definition at line 366 of file bbtkWxBlackBox.cxx.

References bbGetWindow(), bbSetWindow(), and bbtkDebugMessage.

  {
    bbtkDebugMessage("wx",9,"==> WxBlackBox::bbUserDestructor() ["<<bbGetFullName()<<"]"<<std::endl);
    if (bbGetWindow()) {
      delete bbGetWindow();
      bbSetWindow(0);
    }
    bbtkDebugMessage("wx",9,"<== WxBlackBox::bbUserDestructor() ["<<bbGetFullName()<<"]"<<std::endl);
  }

Here is the call graph for this function:

virtual void bbtk::WxBlackBox::bbUserCreateWidget

(

)

[inline, protected, virtual]

User callback for creating the widget associated to the box Must be defined **

Definition at line 142 of file bbtkWxBlackBox.h.

References bbtkError.

Referenced by bbProcess().

    {
      bbtkError(bbGetTypeName()<<" is a WxBlackBox whose bbUserCreateWidget methods is not overloaded : is it a feature or a bug ?!?");
    }

Here is the caller graph for this function:

IOStatus bbtk::WxBlackBox::bbBackwardUpdate

(

Connection::Pointer

caller

)

[protected, virtual]

Main processing method of the box.

Definition at line 456 of file bbtkWxBlackBox.cxx.

References bbGetUpdateTransferedToParent(), bbSetUpdateTransferedToParent(), bbtkDebugMessage, bbtkDebugMessageDec, bbtk::i, bbtk::MODIFIED, and bbtk::UPDATING.

  {
    bbtkDebugMessage("process",3,
                     "=> WxBlackBox::bbBackwardUpdate("
                     <<(caller?caller->GetFullName():"0")<<") ["
                     <<bbGetFullName()<<"]"<<std::endl);
    // If the caller's box to is not the box to connected to the 
    // output 'Widget'
    if ( ! (( bbGetStatus() == MODIFIED ) ||
            ( bbBoxProcessModeIsAlways() )) )
      {
        bbtkDebugMessage("process",3,"Up-to-date : nothing to do"<<std::endl);
        bbtkDebugMessage("process",3,
                         "<= WxBlackBox::bbBackwardUpdate("
                         <<(caller?caller->GetFullName():"0")<<") ["
                         <<bbGetFullName()<<"]"<<std::endl);
        return bbGetStatus();
      }
 
    BlackBox::OutputConnectorMapType::const_iterator i 
      = bbGetOutputConnectorMap().find("Widget") ;
    if ( i->second->GetConnectionVector().size() != 0 )
      
      {
        BlackBox::Pointer to = 
          i->second->GetConnectionVector()[0]->GetBlackBoxTo();
                
        if (caller) 
          {
            bbtkDebugMessage("process",3,
                             "-> Output 'Widget' connected to '"
                             <<to->bbGetFullName()<<"' - caller->to = '"
                             <<caller->GetBlackBoxTo()->bbGetFullName()
                             <<"'"
                             <<std::endl);
          }
        else
          {
            bbtkDebugMessage("process",3,
                             "-> Output 'Widget' connected to '"
                             <<to->bbGetFullName()<<"'"
                             <<std::endl);
          }
        if ((caller==0) ||
            ((caller!=0) && 
             (caller->GetBlackBoxTo() != to))&&
            (!bbGetUpdateTransferedToParent())&&
            (to->bbGetStatus()!=UPDATING))
          {
            bbtkDebugMessage("process",3,
                             "   ... Transfering update order to parent"
                             <<std::endl);
            
            bbSetUpdateTransferedToParent(true);
            i->second->GetConnectionVector().front() //.lock()
              ->GetBlackBoxTo()->bbExecute(false);
          }
        else
          {
            bbSetUpdateTransferedToParent(false);
            bbtkDebugMessage("process",3,
                             "   ... No need to transfer to parent"
                             <<std::endl);
          }
      }
    /*    

    // If the caller is not the connection to the output widget
    // and the output 'Widget' is connected then 
    // we must execute the parent box 
    // but only one time 
    // (this is the role of the flag UpdateTransferedToParent)
    if ( (caller==0) ||
         ((caller!=0)&&(caller->GetBlackBoxFromOutput()!="Widget"))
         )
      {
      }
    */
    // call 'standard' BlackBox execution method
    if (!bbGetUpdateTransferedToParent()) 
      { 
          AtomicBlackBox::bbBackwardUpdate(caller);
      }
    
    bbtkDebugMessageDec("process",3,
                        "<= WxBlackBox::bbBackwardUpdate() ["
                        <<bbGetFullName()<<"]"<<std::endl);
    
   return bbGetStatus();
     

  }

Here is the call graph for this function:

void bbtk::WxBlackBox::bbProcess

(

)

[protected, virtual]

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();

Definition at line 550 of file bbtkWxBlackBox.cxx.

References bbGetOutputWidget(), bbShowWindow(), and bbUserCreateWidget().

  { 
    if (bbGetOutputWidget()==0) this->bbUserCreateWidget();
    this->bbUserProcess(); 
    bbShowWindow();
    //    this->bbUserOnShow();
  }

Here is the call graph for this function:

void bbtk::WxBlackBox::bbShowWindow

(

)

[protected]

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)

Specific methods for window creation during pipeline execution Shows the window associated to the box (called after bbProcess during bbExecute)

show->IsShown())

Definition at line 563 of file bbtkWxBlackBox.cxx.

References bbGetInputWinDialog(), bbGetInputWinHeight(), bbGetInputWinTitle(), bbGetInputWinWidth(), bbGetOutputWidget(), bbGetWidgetEventHandler(), bbGetWindow(), bbGetWxParent(), bbtk::WxBlackBoxWindow::bbShow(), bbtkDebugMessage, bbtkDebugMessageInc, bbtkError, and bbtk::std2wx().

Referenced by bbProcess().

  {
    bbtkDebugMessageInc("wx",1,"=> WxBlackBox::bbShowWindow() ["
                        <<bbGetFullName()<<"]"<<std::endl);
 
    // If Event Handler for the widget does not exist or is obsolete : create it 
    if (bbGetOutputWidget()!=0)
      {
        if (bbGetWidgetEventHandler()==0)
          {
            bbtkDebugMessage("wx",3,
                             "-> No widget event handler : creating one"
                             <<std::endl);
            new WxBlackBoxWidgetEventHandler(GetThisPointer<WxBlackBox>(),
                                             bbGetOutputWidget());
          }
        else if ( ! bbGetWidgetEventHandler()->IsHandlerOf 
                  ( bbGetOutputWidget() ) )
          {
            bbtkDebugMessage("wx",3,
                             "-> Obsolete widget event handler : re-creating one"
                             <<std::endl);
            delete bbGetWidgetEventHandler();
            new WxBlackBoxWidgetEventHandler(GetThisPointer<WxBlackBox>(),
                                             bbGetOutputWidget());
          }
        // Sets the name of the wxWindow to the input WinTitle
        bbGetOutputWidget()->SetName(bbtk::std2wx(bbGetInputWinTitle()));
      }

    // If the output 'Widget' is connected then it's gonna 
    // be captured by its parent window : nothing to do 
    if ( (*bbGetOutputConnectorMap().find("Widget")).second
         ->GetConnectionVector().size() != 0 ) 
      {
        
        bbtkDebugMessage("wx",2,
                         "-> Output 'Widget' connected : nothing to do"
                         <<std::endl);
        return;
      }


    Window* show = 0;
    // If the window already exists : no need creating it
    if (bbGetWindow()!=0)
      {
        bbtkDebugMessage("wx",2,
                         "-> Window already exists"
                         <<std::endl);
        show = bbGetWindow();
      }
    // Else if the widget exists : create window 
    else if (bbGetOutputWidget()!=0) 
      {
        bbtkDebugMessage("wx",2,
                         "-> Widget exists : creating the window"
                         <<std::endl);


        // Input WinDialog set to true : creating a Dialog
        if (bbGetInputWinDialog()) 
          {
            bbtkDebugMessage("wx",2,
                             "   Input WinDialog set to true : creating a Dialog"
                             <<std::endl);
            show = (Window*) new WxBlackBoxDialog( GetThisPointer<WxBlackBox>(),
                                                   bbGetWxParent(), 
                                                   std2wx( bbGetInputWinTitle() + " - bbtk (c) CREATIS LRMN"),
                                                   wxSize( bbGetInputWinWidth() , bbGetInputWinHeight() ) );
          }
        // Input WinDialog set to false : creating a Frame
        else 
          {
            bbtkDebugMessage("process",2,
                             "   Input WinDialog set to false : creating a Frame"
                             <<std::endl);
            show = (Window*) new WxBlackBoxFrame( GetThisPointer<WxBlackBox>(),
                                                  bbGetWxParent(), 
                                                  std2wx( bbGetInputWinTitle()  + " - bbtk (c) CREATIS LRMN"),
                                                  wxSize( bbGetInputWinWidth() , bbGetInputWinHeight() ) );
          }

      }
    // No window nor widget : error
    else
      {
        bbtkError("WxBlackBox::bbShowWindow() ["
                  <<bbGetFullName()
                  <<"] : No widget. Did you set the box output 'Widget' in the processing method of the box ?");
      }
 
    
    // Show the window
    if (true) 
      {
        show->bbShow(); 
      }
    else 
      {
        bbtkDebugMessage("wx",2,"-> Already shown : nothing to do"<<std::endl);
      }
  

    bbtkDebugMessage("wx",1,"<= WxBlackBox::bbShowWindow() ["
                        <<bbGetFullName()<<"]"<<std::endl);

  }

Here is the call graph for this function:

Here is the caller graph for this function:

void bbtk::WxBlackBox::bbHideWindow

(

)

[protected]

Hides the WxBlackBoxWindow associated to the box (if exists).

Definition at line 677 of file bbtkWxBlackBox.cxx.

References bbGetWindow(), bbtk::WxBlackBoxWindow::bbHide(), bbtkDebugMessageDec, and bbtkDebugMessageInc.

  {
    bbtkDebugMessageInc("wx",1,"=> WxBlackBox::bbHideWindow() ["
                        <<bbGetFullName()<<"]"<<std::endl);

    if (bbGetWindow()!=0) bbGetWindow()->bbHide();

    bbtkDebugMessageDec("wx",1,"<= WxBlackBox::bbHideWindow() ["
                        <<bbGetFullName()<<"]"<<std::endl);
  }

Here is the call graph for this function:

void bbtk::WxBlackBox::bbCloseWindow

(

)

[protected]

Closes (destroys) the WxBlackBoxWindow associated to the box (if exists).

Definition at line 691 of file bbtkWxBlackBox.cxx.

References bbtk::WxBlackBoxWindow::bbClose(), bbGetWindow(), bbtkDebugMessageDec, and bbtkDebugMessageInc.

  {
    bbtkDebugMessageInc("wx",1,"=> WxBlackBox::bbCloseWindow() ["
                        <<bbGetFullName()<<"]"<<std::endl);

    if (bbGetWindow()!=0) bbGetWindow()->bbClose();

    bbtkDebugMessageDec("wx",1,"<= WxBlackBox::bbCloseWindow() ["
                        <<bbGetFullName()<<"]"<<std::endl);
  }

Here is the call graph for this function:

void bbtk::WxBlackBox::bbSetWindow

(

Window *

w

)

[inline, private]

Sets the window.

Definition at line 186 of file bbtkWxBlackBox.h.

Referenced by bbUserDestructor().

{ bbmWindow=w; }

Here is the caller graph for this function:

void bbtk::WxBlackBox::bbSetWidgetEventHandler

(

WxBlackBoxWidgetEventHandler *

w

)

[inline, private]

Sets the Widget Event Handler.

Definition at line 189 of file bbtkWxBlackBox.h.

Referenced by bbInitAttributes().

    { bbmWidgetEventHandler = w; }

Here is the caller graph for this function:

WxBlackBoxWidgetEventHandler* bbtk::WxBlackBox::bbGetWidgetEventHandler

(

)

[inline, private]

Gets the Widget Event Handler.

Definition at line 192 of file bbtkWxBlackBox.h.

Referenced by bbShowWindow().

    { return bbmWidgetEventHandler; }

Here is the caller graph for this function:

void bbtk::WxBlackBox::bbInitAttributes

(

)

[private]

Initialize the attributes of the class.

Definition at line 401 of file bbtkWxBlackBox.cxx.

References bbmWindow, bbSetInputWinDialog(), bbSetInputWinHeight(), bbSetInputWinTitle(), bbSetInputWinWidth(), bbSetOutputWidget(), bbSetUpdateTransferedToParent(), and bbSetWidgetEventHandler().

Referenced by bbUserConstructor(), and bbUserCopyConstructor().

  {
    bbmWindow = 0;
    //    bbmWidget = 0;
    //    bbSetInputWinParent(0);
    bbSetInputWinTitle(bbGetName());
    bbSetInputWinWidth(800);
    bbSetInputWinHeight(800);
    bbSetInputWinDialog(false);
    bbSetOutputWidget(0);

    bbSetWidgetEventHandler(0);
    bbSetUpdateTransferedToParent(false);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

bool bbtk::WxBlackBox::bbGetUpdateTransferedToParent

(

)

const [inline, protected]

Definition at line 213 of file bbtkWxBlackBox.h.

Referenced by bbBackwardUpdate().

{ return bbmUpdateTransferedToParent; }

Here is the caller graph for this function:

void bbtk::WxBlackBox::bbSetUpdateTransferedToParent

(

bool

b

)

[inline, protected]

Definition at line 214 of file bbtkWxBlackBox.h.

Referenced by bbBackwardUpdate(), and bbInitAttributes().

    { bbmUpdateTransferedToParent = b; }

Here is the caller graph for this function:

---

Friends And Related Function Documentation

friend struct Object::Deleter [friend]

Definition at line 79 of file bbtkWxBlackBox.h.

friend class WxBlackBoxWindow [friend]

friendship

Definition at line 182 of file bbtkWxBlackBox.h.

friend class WxBlackBoxWidgetEventHandler [friend]

Definition at line 183 of file bbtkWxBlackBox.h.

---

Member Data Documentation

std::string bbtk::WxBlackBox::bbmInputWinTitle [protected]

Definition at line 79 of file bbtkWxBlackBox.h.

int bbtk::WxBlackBox::bbmInputWinWidth [protected]

Definition at line 81 of file bbtkWxBlackBox.h.

int bbtk::WxBlackBox::bbmInputWinHeight [protected]

Definition at line 82 of file bbtkWxBlackBox.h.

bool bbtk::WxBlackBox::bbmInputWinDialog [protected]

Definition at line 83 of file bbtkWxBlackBox.h.

Void bbtk::WxBlackBox::bbmInputWinHide [protected]

Definition at line 84 of file bbtkWxBlackBox.h.

Void bbtk::WxBlackBox::bbmInputWinClose [protected]

Definition at line 85 of file bbtkWxBlackBox.h.

wxWindow* bbtk::WxBlackBox::bbmOutputWidget [protected]

Definition at line 86 of file bbtkWxBlackBox.h.

Window* bbtk::WxBlackBox::bbmWindow [private]

The WxBlackBoxWindow associated to the box.

Definition at line 197 of file bbtkWxBlackBox.h.

Referenced by bbInitAttributes().

WxBlackBoxWidgetEventHandler* bbtk::WxBlackBox::bbmWidgetEventHandler [private]

The WxBlackBoxWidgetEventHandler associated to the box.

Definition at line 199 of file bbtkWxBlackBox.h.

bool bbtk::WxBlackBox::bbmUpdateTransferedToParent [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...

Definition at line 211 of file bbtkWxBlackBox.h.

---

The documentation for this class was generated from the following files:

• /home/guigues/bbtk-build-tmp/bbtk/kernel/src/bbtkWxBlackBox.h
• /home/guigues/bbtk-build-tmp/bbtk/kernel/src/bbtkWxBlackBox.cxx