INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES

indexing

title: "EOLE_ADVISE_SINK", "The IAdviseSink interface enables containers and other", "objects to receive notifications of data changes,", "view changes, and compound-document changes occurring in", "objects of interest. Container applications, for example,", "require such notifications to keep cached presentations of", "their linked and embedded objects up-to-date.", "Calls to IAdviseSink methods are asynchronous, so the call", "is sent and then the next instruction is executed without", "waiting for the call%'s return."
project: "Visual Eiffel Library"
revision: "$Revision: 1.2 $"
copyright: "Copyright (C) 1996-2005 Object Tools Group"
license: "http://visual-eiffel.com/license"
cluster: wine
class EOLE_ADVISE_SINK
inherit

EOLE_UNKNOWN
redefine
create_ole_interface_ptr,
on_query_interface
end
creation

make
feature

make
--
-- Purpose:
-- Creates an pbject.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- It's a dummy constructor now.
--

create_ole_interface_ptr: POINTER
--
-- Purpose:
-- Create an C++ virtual table, corresponding to
-- IAdviseSink interface.
-- Params:
-- None.
-- Return Value:
-- Pointer to created VTBL.
-- Notes:
-- None.
--

on_data_change (formatetc: EOLE_FORMATETC; stgmed: EOLE_STGMEDIUM)
--
-- Purpose:
-- Called by the server to notify a data object's currently
-- registered advise sinks that data in the object has changed.
-- Params:
-- Formatetc: EOLE_FORMATETC [in] EOLE_FORMATETC structure, which
-- describes the format, target
-- device, rendering, and storage
-- information of the calling data
-- object.
-- Stgmed: EOLE_STGMEDIUM [in] EOLE_STGMEDIUM structure, which
-- defines the storage medium
-- (global memory, disk file,
-- storage object, stream object,
-- GDI object, or undefined) and
-- ownership of that medium for
-- the calling data object.
-- Return Value:
-- None.
-- Notes:
-- This method does not return status code.
--

on_view_change (aspect, index: INTEGER)
--
-- Purpose:
-- Notifies an object's registered advise sinks that its view has
-- changed.
-- Params:
-- Aspect: INTEGER [in] Specifies the aspect, or view, of the
-- object. Contains a value taken from the
-- enumeration, EOLE_DVASPECT.
-- Index: INTEGER [in] Identifies which piece of the view has
-- changed.
-- CURRENTLY ONLY -1 IS VALID!!!!.
-- Return Value:
-- None.
-- Notes:
-- This method does not return status code.
--

on_rename (mnk: EOLE_MONIKER)
--
-- Purpose:
-- Called by the server to notify all registered advisory sinks
-- that the object has been renamed.
-- Params:
-- mnk: EOLE_MONIKER [in] Pointer to the IMoniker interface on
-- the new full moniker of the object.
-- Return Value:
-- None.
-- Notes:
-- This method does not return status code.
--

on_save
--
-- Purpose:
-- Called by the server to notify all registered advisory sinks
-- that the object has been saved.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- This method does not return status code.
--

on_close
--
-- Purpose:
-- Called by the server to notify all registered advisory sinks
-- that the object has changed from the running to the loaded state.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- This method does not return status code.
--
end -- class EOLE_ADVISE_SINK

INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES