fgl::FGConnector Class Reference

#include <base.h>

Inheritance diagram for fgl::FGConnector:

[legend]Collaboration diagram for fgl::FGConnector:

[legend]List of all members.

---

Detailed Description

This object is provided for common communication between any two OpenGUI graphics objects. By default is this unconnected. When you want connect the two objects to sending signal from one object to other, simply call the Connect() method. In called object you must overload virtual methods OnSignal(). When signal from one to other object is emited, there is one optional parameter that is transmited. You can set this parameter with Connect() or late by calling SetParam().

See also:

FGCONNECT

Public Member Functions
void __fastcall	SetParameter (void *a)
void *__fastcall	GetParameter (void) const
void __fastcall	Connect (FGConnector *from, void *par)
virtual void	OnSignal (FGConnector *sender, void *value)
void __fastcall	RunSignal (void)

---

Member Function Documentation

void __fastcall fgl::FGConnector::Connect (  FGConnector *  from, void *  par )  [inline]

Connects other object pointed by 'from' and set an optional value. Note: There is allowed only one bindings between two objects at one time, 'The last, is the winner'! Parameters: from  other object of this kind to connect with us par  user value/event code/magic number

void* __fastcall fgl::FGConnector::GetParameter (  void   )  const [inline]

This is an trivial way to solve problem with unavailable related user defined parameter. You can use method SetParam() to any Window to assign some parameter of int type. Since you can read this parameter at other place by GetParam(). If returned value is -1, value is not assigned.

virtual void fgl::FGConnector::OnSignal (  FGConnector *  sender, void *  value )  [inline, virtual]

do nothing - override in your code

void __fastcall fgl::FGConnector::RunSignal (  void   )  [inline]

Try emit defined signal if there is any.

void __fastcall fgl::FGConnector::SetParameter (  void *  a  )  [inline]

This is an trivial way to solve problem with unavailable related user defined parameter. You can use method SetParam() to any Window to assign some parameter of int type. Since you can read this parameter at other place by GetParam(). If returned value is -1, value is not assigned.

---