Wt::JSlot Class Reference
[Signal/slot system]

A slot that is only implemented in client side JavaScript code. More...

#include <Wt/WJavaScript>

List of all members.

Public Member Functions

 JSlot (WWidget *parent=0)
 Construct a JavaScript-only slot within the parent scope.
 JSlot (const std::string &javaScript, WWidget *parent=0)
 Construct a JavaScript-only slot with given JavaScript.
 ~JSlot ()
 Destructor.
void setJavaScript (const std::string &js)
 Set or modify the JavaScript code associated with the slot.
void exec ()
 Execute the JavaScript code.


Detailed Description

A slot that is only implemented in client side JavaScript code.

This class provides a hook for adding your own JavaScript to respond to events.

Carefully consider the use of this. Not only is writing cross-browser JavaScript hard and tedious, but one must also be aware of possible security problems (see further), and ofcourse, the event handling will not be available when JavaScript is disabled or not present at all.

If you wish to add client side event handling, with automatic fall-back to server-side event handling and without writing JavaScript code with the associated risks and problems, consider using stateless slot implementations instead (see WObject::implementStateless())

For some purposes, stateless slot implementations are not sufficient, since they do not allow state inspection. At the same time, the non-availability in case of disabled JavaScript may also be fine for some non-essential functionality (see for example the WSuggestionPopup widget), or when you simply do not care. For these situations a JSlot can be used to add client-side event handling.

The JavaScript code may be set (or changed) using the setJavaScript() method which takes a string that implements a JavaScript function with the following signature:

 function(sender, event) {
   // handle the event, and sender is a reference to the DOM element
   // which captured the event (and holds the signal). Therefore it
   // equivalent to the sender for a normal %Wt slot.

   // You can prevent the default action using:
   ${WT_CLASS}.cancelEvent(event);
   // (where ${WT_CLASS} should be the value of the WT_CLASS define
 }

In the JavaScript code, you may use WWidget::jsRef() to obtain the DOM element corresponding to any WWidget, or WWidget::id() to obtain the DOM id. In addition you may trigger server-side events using the JavaScript WtSignalEmit function (see JSignal documentation). That's how far we can help you. For the rest you are left to yourself, buggy browsers and quirky JavaScript (http://www.quirksmode.org/ was a reliable companion to me) -- good luck.


Constructor & Destructor Documentation

Wt::JSlot::JSlot ( WWidget parent = 0  ) 

Construct a JavaScript-only slot within the parent scope.

The JavaScript will reside within the scope of the given widget. By picking a long-lived parent, one may reuse a single block of JavasCript code for multiple widgets.

If parent = 0, then the JavaScript will be inline.

Wt::JSlot::JSlot ( const std::string &  javaScript,
WWidget parent = 0 
)

Construct a JavaScript-only slot with given JavaScript.

See also:
JSlot(WWidget *), setJavaScript()


Member Function Documentation

void Wt::JSlot::setJavaScript ( const std::string &  js  ) 

Set or modify the JavaScript code associated with the slot.

When the slot is triggered, the corresponding JavaScript is executed.

The JavaScript function takes two parameters and thus should look like:

     function(obj, event) {
       // ...
     }

The first parameter obj is a reference to the DOM element that generates the event. The event refers to the JavaScript event object.

See also:
WWidget::jsRef()

void Wt::JSlot::exec (  ) 

Execute the JavaScript code.

Execute the JavaScript code, in the same way as when triggered by a EventSignal. This function returns immediately, and execution of the JavaScript code is deferred until after the event handling.


Generated on Tue Sep 1 17:51:16 2009 for Wt by doxygen 1.5.6