Class: WIN32OLE_EVENT
- Inherits:
-
Object
- Object
- WIN32OLE_EVENT
- Defined in:
- win32ole.c,
win32ole.c
Overview
WIN32OLE_EVENT
objects controls OLE event.
Class Method Summary collapse
-
.message_loop ⇒ Object
Translates and dispatches Windows message.
Instance Method Summary collapse
-
#handler ⇒ Object
returns handler object.
-
#handler= ⇒ Object
sets event handler object.
-
#new(ole, event) ⇒ Object
constructor
Returns OLE event object.
-
#off_event([event]) ⇒ Object
removes the callback of event.
-
#on_event([event]) { ... } ⇒ Object
Defines the callback event.
-
#on_event_with_outargs([event]) { ... } ⇒ Object
Defines the callback of event.
-
#unadvise ⇒ nil
disconnects OLE server.
Constructor Details
#new(ole, event) ⇒ Object
Returns OLE event object. The first argument specifies WIN32OLE object. The second argument specifies OLE event name.
ie = WIN32OLE.new('InternetExplorer.Application')
ev = WIN32OLE_EVENT.new(ie, 'DWebBrowserEvents')
8398 8399 8400 8401 8402 8403 8404 8405 8406 |
# File 'win32ole.c', line 8398
static VALUE
fev_initialize(int argc, VALUE *argv, VALUE self)
{
ev_advise(argc, argv, self);
evs_push(self);
rb_ivar_set(self, id_events, rb_ary_new());
fev_set_handler(self, Qnil);
return self;
}
|
Class Method Details
.message_loop ⇒ Object
Translates and dispatches Windows message.
8414 8415 8416 8417 8418 8419 |
# File 'win32ole.c', line 8414
static VALUE
fev_s_msg_loop(VALUE klass)
{
ole_msg_loop();
return Qnil;
}
|
Instance Method Details
#handler ⇒ Object
returns handler object.
8657 8658 8659 8660 8661 |
# File 'win32ole.c', line 8657
static VALUE
fev_get_handler(VALUE self)
{
return rb_ivar_get(self, rb_intern("handler"));
}
|
#handler= ⇒ Object
sets event handler object. If handler object has onXXX method according to XXX event, then onXXX method is called when XXX event occurs.
If handler object has method_missing and there is no method according to the event, then method_missing called and 1-st argument is event name.
If handler object has onXXX method and there is block defined by WIN32OLE_EVENT#on_event(‘XXX’){}, then block is executed but handler object method is not called when XXX event occurs.
class Handler
def onStatusTextChange(text)
puts "StatusTextChanged"
end
def onPropertyChange(prop)
puts "PropertyChanged"
end
def method_missing(ev, *arg)
puts "other event #{ev}"
end
end
handler = Handler.new
ie = WIN32OLE.new('InternetExplorer.Application')
ev = WIN32OLE_EVENT.new(ie)
ev.on_event("StatusTextChange") {|*args|
puts "this block executed."
puts "handler.onStatusTextChange method is not called."
}
ev.handler = handler
8644 8645 8646 8647 8648 |
# File 'win32ole.c', line 8644
static VALUE
fev_set_handler(VALUE self, VALUE val)
{
return rb_ivar_set(self, rb_intern("handler"), val);
}
|
#off_event([event]) ⇒ Object
removes the callback of event.
ie = WIN32OLE.new('InternetExplorer.Application')
ev = WIN32OLE_EVENT.new(ie)
ev.on_event('BeforeNavigate2') {|*args|
args.last[6] = true
}
...
ev.off_event('BeforeNavigate2')
...
8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 |
# File 'win32ole.c', line 8527
static VALUE
fev_off_event(int argc, VALUE *argv, VALUE self)
{
VALUE event = Qnil;
VALUE events;
rb_scan_args(argc, argv, "01", &event);
if(!NIL_P(event)) {
if(TYPE(event) != T_STRING && TYPE(event) != T_SYMBOL) {
rb_raise(rb_eTypeError, "wrong argument type (expected String or Symbol)");
}
if (TYPE(event) == T_SYMBOL) {
event = rb_sym_to_s(event);
}
}
events = rb_ivar_get(self, id_events);
if (NIL_P(events)) {
return Qnil;
}
ole_delete_event(events, event);
return Qnil;
}
|
#on_event([event]) { ... } ⇒ Object
Defines the callback event. If argument is omitted, this method defines the callback of all events. If you want to modify reference argument in callback, return hash in callback. If you want to return value to OLE server as result of callback use ‘return’ or :return.
ie = WIN32OLE.new('InternetExplorer.Application')
ev = WIN32OLE_EVENT.new(ie)
ev.on_event("NavigateComplete") {|url| puts url}
ev.on_event() {|ev, *args| puts "#{ev} fired"}
ev.on_event("BeforeNavigate2") {|*args|
...
# set true to BeforeNavigate reference argument `Cancel'.
# Cancel is 7-th argument of BeforeNavigate,
# so you can use 6 as key of hash instead of 'Cancel'.
# The argument is counted from 0.
# The hash key of 0 means first argument.)
{:Cancel => true} # or {'Cancel' => true} or {6 => true}
}
ev.on_event(...) {|*args|
{:return => 1, :xxx => yyy}
}
8486 8487 8488 8489 8490 |
# File 'win32ole.c', line 8486
static VALUE
fev_on_event(int argc, VALUE *argv, VALUE self)
{
return ev_on_event(argc, argv, self, Qfalse);
}
|
#on_event_with_outargs([event]) { ... } ⇒ Object
Defines the callback of event. If you want modify argument in callback, you could use this method instead of WIN32OLE_EVENT#on_event.
ie = WIN32OLE.new('InternetExplorer.Application')
ev = WIN32OLE_EVENT.new(ie)
ev.on_event_with_outargs('BeforeNavigate2') {|*args|
args.last[6] = true
}
8506 8507 8508 8509 8510 |
# File 'win32ole.c', line 8506
static VALUE
fev_on_event_with_outargs(int argc, VALUE *argv, VALUE self)
{
return ev_on_event(argc, argv, self, Qtrue);
}
|
#unadvise ⇒ nil
disconnects OLE server. If this method called, then the WIN32OLE_EVENT object does not receive the OLE server event any more. This method is trial implementation.
ie = WIN32OLE.new('InternetExplorer.Application')
ev = WIN32OLE_EVENT.new(ie)
ev.on_event() {...}
...
ev.unadvise
8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 |
# File 'win32ole.c', line 8565
static VALUE
fev_unadvise(VALUE self)
{
struct oleeventdata *poleev;
Data_Get_Struct(self, struct oleeventdata, poleev);
if (poleev->pConnectionPoint) {
ole_msg_loop();
evs_delete(poleev->event_id);
poleev->pConnectionPoint->lpVtbl->Unadvise(poleev->pConnectionPoint, poleev->dwCookie);
OLE_RELEASE(poleev->pConnectionPoint);
poleev->pConnectionPoint = NULL;
}
return Qnil;
}
|