INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES

indexing

title: "EOLE_CLIENT_SITE", "The IOleClientSite interface is the primary means by which", "an embedded object obtains information about the location", "and extent of its display site; its moniker; its user", "interface; and other resources provided by its container.", "An object server calls IOleClientSite to request services", "from the container. A container must provide one instance of", "IOleClientSite for every compound-document object it contains."
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_CLIENT_SITE
inherit

EOLE_UNKNOWN
redefine
create_ole_interface_ptr,
on_query_interface
end
creation

make
feature

make
--
-- Purpose:
-- Creates an object.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- None.
--

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

save_object
--
-- Purpose:
-- Saves the object associated with the client site.
-- This function is synchronous; by the time it returns,
-- the save will be completed.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- None.
--

get_moniker (assigntype, whichmoniker: INTEGER): EOLE_MONIKER
--
-- Purpose:
-- Returns a moniker to an object's client site.
-- An object can force the assignment of its own or its
-- container's moniker by specifying a value for dwAssign.
-- Params:
-- AssignType: INTEGER [in] Specifies whether to get a moniker
-- only if one has already exists,
-- force assignment of a moniker,
-- create a temporary moniker, or
-- remove a moniker that has been
-- assigned. In practice you will
-- usually request that the container
-- force assignment of the moniker.
-- Values defining these choices are
-- contained in the enumeration
-- EOLE_GETMONIKER.
-- WhichMoniker: INTEGER [in] Specifies whether to return the
-- container's moniker, the object's
-- moniker relative to the container,
-- or the object's full moniker.
-- In practice, you will usually
-- request the object's full moniker.
-- Values defining these choices are
-- contained in the enumeration
-- EOLE_WHICHMK.
-- Return Value:
-- Resulting moniker.
-- Notes:
-- None.
--

get_container: EOLE_CONTAINER
--
-- Purpose:
-- Returns a pointer to the container's IOleContainer interface.
-- Params:
-- None.
-- Return Value:
-- Resulting container.
-- Notes:
-- None.
--

show_object
--
-- Purpose:
-- Tells the container to position the object so it is visible to
-- the user. This method ensures that the container itself is
-- visible and not minimized.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- None.
--

on_show_window (show: BOOLEAN)
--
-- Purpose:
-- Notifies a container when an embedded object's window is about
-- to become visible or invisible. This method does not apply to
-- an object that is activated in place and therefore has no
-- window separate from that of its container.
-- Params:
-- Show: BOOLEAN [in] Indicates whether an object's window is
-- open (TRUE) or closed (FALSE).
-- Return Value:
-- None.
-- Notes:
-- None.
--

request_new_object_layout
--
-- Purpose:
-- Asks container to allocate more or less space for displaying
-- an embedded object.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- None.
--
end -- class EOLE_CLIENT_SITE

INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES