Wt::WSignalMapper< T, A1 > Class Template Reference
[Signal/slot system]

A utility class to connect multiple senders to a single slot. More...

#include <Wt/WSignalMapper>

Inheritance diagram for Wt::WSignalMapper< T, A1 >:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 WSignalMapper (WObject *parent=0)
 Create a new WSignalMapper.
void setMapping (WObject *sender, const T &data)
 Associate data with a sender.
void mapConnect (SignalBase &signal, const T &data)
 Map a signal without arguments.
template<typename S>
void mapConnect1 (S &signal, const T &data)
 Map a signal with one argument.
Signal< T, A1 > & mapped ()
 Signal emitted in response to a signal sent to map() or map1().
void map ()
 Slot to which to connect the source signal.
void map1 (A1 a)
 Slot to which to connect the source signal, passing the argument to the receiver.


Detailed Description

template<typename T, typename A1 = NoClass>
class Wt::WSignalMapper< T, A1 >

A utility class to connect multiple senders to a single slot.

This class is useful if you would like to respond to signals of many objects or widgets within a single slot, but need to identify the particular sender through some property.

Usage example:

 void Test::createWidgets()
 {
   Wt::WSignalMapper<WText *> *MyMap = new Wt::WSignalMapper<Wt::WText *>(this);
   // connect mapped() to our target slot
   MyMap->mapped().connect(SLOT(this, Test::onClick));

   // connect and map every source signal to the mapper
   MyMap->mapConnect(text1->clicked(), text1);
   MyMap->mapConnect(text2->clicked(), text2);
   MyMap->mapConnect(text3->clicked(), text3);
 }

 void Test::onClick(WText* source)
 {
   // source is where it is coming from
   // ...
 }

The type T may be any type that has proper copy semantics and a default constructor. The mapper may pass one extra argument (type A1) from the original signal to the mapped() signal. In that case, you must connect the original signal to the map1() slot, or use mapConnect1().


Member Function Documentation

template<typename T, typename A1>
void Wt::WSignalMapper< T, A1 >::setMapping ( WObject sender,
const T &  data 
) [inline]

Associate data with a sender.

Associate data with a sender, which wel emitted by the mapped() signal, when the corresponding sender signal triggers map() or map1().

template<typename T, typename A1>
void Wt::WSignalMapper< T, A1 >::mapConnect ( SignalBase &  signal,
const T &  data 
) [inline]

Map a signal without arguments.

Connect the given signal with the slot, and associate the data when it is triggered.

 Wt::WSignalMapper<T> *mapper = ...

 mapper->mapConnect(widget->clicked(), data);
is equivalent to:
 Wt::WSignalMapper<T> *mapper = ...

 widget->clicked().connect(SLOT(mapper, Wt::WSignalMapper<T>::map));
 mapper->setMapping(widget, data);

template<typename T, typename A1>
template<typename S>
void Wt::WSignalMapper< T, A1 >::mapConnect1 ( S &  signal,
const T &  data 
) [inline]

Map a signal with one argument.

Connect the given signal with the slot, and associate the data when it is triggered. The signal argument will be passed to the mapped() signal.

 Wt::WSignalMapper<T, Wt::WMouseEvent> *mapper = ...

 mapper->mapConnect(widget->clicked(), data);
is equivalent to:
 Wt::WSignalMapper<T, Wt::WMouseEvent> *mapper = ...

 widget->clicked().connect(SLOT(mapper, Wt::WSignalMapper<T, Wt::WMouseEvent>::map1));
 mapper->setMapping(widget, data);

template<typename T, typename A1 = NoClass>
Signal<T, A1>& Wt::WSignalMapper< T, A1 >::mapped (  )  [inline]

Signal emitted in response to a signal sent to map() or map1().

The first argument propagated is the data that is associated with the specific sender, set in setMapping() or mapConnect(). The second argument is an argument passed from the originating signal.

template<typename T, typename A1>
void Wt::WSignalMapper< T, A1 >::map (  )  [inline]

Slot to which to connect the source signal.

When a signal triggers the slot, the sender is identified and used to find corresponding data set with setMapping(), which is then use to propagate further in the mapped() signal.

template<typename T, typename A1>
void Wt::WSignalMapper< T, A1 >::map1 ( A1  a  )  [inline]

Slot to which to connect the source signal, passing the argument to the receiver.

When a signal triggers the slot, the sender is identified and used to find corresponding data set with setMapping(), which is then use to propagate further in the mapped() signal. The additional argument a is passed as the second argument to the mapped() signal.


Generated on Mon Mar 9 08:27:51 2009 for Wt by doxygen 1.5.6