INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES

indexing

title: "EOLE_CONTROL_SITE", "A container that supports the embedding of OLE Controls", "implements a site object to manage each control. A site", "object supports IOleControlSite as well as other site", "interfaces such as IOleClientSite and IOleInPlaceSite.", "When an OLE Control requires the services expressed through", "this interface, it will query one of the other client site", "interfaces for IOleControlSite."
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_CONTROL_SITE
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
-- IOleControlSite interface.
-- Params:
-- None.
-- Return Value:
-- Pointer to created VTBL.
-- Notes:
-- None.
--

on_controlinfo_changed
--
-- Purpose:
-- Informs the container that the control's CONTROLINFO structure
-- has changed and that the container should call the control's
-- IOleControl::GetControlInfo for an update.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
-- (Always must be EOLE_S_OK)
--

lock_inplace_activate (flock: BOOLEAN)
--
-- Purpose:
-- Indicates whether or not this control should remain in-place
-- active. Calls to this method typically nest an event to ensure
-- that the object's activation state remains stable throughout
-- the processing of the event.
-- Params:
-- fLock: BOOLEAN [in] Indicates whether to ensure the in-place
-- active state (TRUE) or to allow activation
-- to change (FALSE). When TRUE, a supporting
-- container must not deactivate the in-place
-- object until this method is called again
-- with FALSE.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--

get_extended_control: EOLE_DISPATCH
--
-- Purpose:
-- Requests an IDispatch pointer to the extended control that the
-- container uses to wrap the real control.
-- Params:
-- None.
-- Return Value:
-- Indirectly points to the extended control's IDispatch interface.
-- Void returned on failure. On success, the caller is responsible
-- for calling IDispatch::Release when this pointer is no longer
-- needed.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--

transform_coords (ptlhimetric: EOLE_POINTL; ptfcontainer: EOLE_POINTF; dwflags: INTEGER)
--
-- Purpose:
-- Converts between a EOLE_POINTL structure expressed in
-- HIMETRIC units (as is standard in OLE) to a EOLE_POINTF
-- structure expressed in whatever units the container finds most
-- convenient for itself. By converting the methods, the control
-- can ensure that it sends coordinate information to the container
-- in units that are directly usable in the container without
-- additional conversion.
-- Params:
-- ptlHimetric: EOLE_POINTL [in/out] Points to a EOLE_POINTL
-- structure containing coordinates
-- expressed in HIMETRIC units.
-- This is an [in] parameter when
-- dwFlags contains
-- EOLE_XFORMCOORDS_HIMETRICTOCONTAINER
-- it is [out] with
-- EOLE_XFORMCOORDS_CONTAINERTOHIMETRIC.
-- In the latter case, the contents
-- are undefined on error.
-- ptfContainer: EOLE_POINTF [in/out] Points to a caller-allocated
-- EOLE_POINTF structure that
-- receives the converted
-- coordinates. This is an [in]
-- parameter when dwFlags
-- contains
-- EOLE_XFORMCOORDS_CONTAINERTOHIMETRIC
-- it is [out] with
-- EOLE_XFORMCOORDS_HIMETRICTOCONTAINER.
-- In the latter case, the contents
-- are undefined on error.
-- Return Value:
-- None.
-- Notes:
-- * Error code of this operation is available via
-- the 'get_status_code' method.
-- * This operation changes its [out] parameter.
-- * Valid valus of dwFlags parameter are specified in
-- EOLE_XFORMSCOORDS class. (exfcoord.e)
--

translate_accelerator (msg: EOLE_MESSAGE; fmodifiers: INTEGER)
--
-- Purpose:
-- Instructs the control site to process the keystroke described
-- in Msg and modified by the flags in fModifiers.
-- Params:
-- Msg: EOLE_MESSAGE [in] EOLE_MESSAGE structure describing
-- the keystroke to be processed.
-- fModifiers: INTEGER [in] Flags describing the state of
-- the Control, Alt, and Shift keys.
-- The value of the flag can be any
-- valid EOLE_KEYMODIFIERS enumeration
-- values.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--

on_focus (gotfocus: BOOLEAN)
--
-- Purpose:
-- Indicates whether the control managed by this control site has
-- gained or lost the focus, according to the GotFocus parameter.
-- The container uses this information to update the state of
-- Default and Cancel buttons according to how the control with
-- the focus processes Return or Esc keys. A control's behavior
-- regarding the Return and Esc keys is specified in the control's
-- EOLE_CONTROLINFO structure. See IOleControl::GetControlInfo.
-- Params:
-- GotFocus: BOOLEAN [in] Indicates whether the control gained
-- (TRUE) or lost the focus (FALSE).
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--

show_property_frame
--
-- Purpose:
-- Instructs a container to display a property sheet for the
-- control embedded in this site.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--
end -- class EOLE_CONTROL_SITE

INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES