INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES

indexing

title: "EOLE_INPLACE_SITE", "The IOleInPlaceSite interface manages interaction between the", "container and the object%'s in-place client site. Recall that", "the client site is the display site for embedded objects, and", "provides position and conceptual information about the object.", "This interface provides methods that manage in-place objects.", "With IOleInPlaceSite, you can determine if an object can be", "activated and manage its activation and deactivation. You can", "notify the container when one of its objects is being", "activated and inform the container that a composite menu will", "replace the container%'s regular menu. It provides methods", "that make it possible for the in-place object to retrieve the", "window object hierarchy, and the position in the parent", "window where the object should place its in-place activation", "window. And finally, it manages how the container scrolls the", "object, its undo state, and notifies the object when its ", "borders have changed."
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_INPLACE_SITE
inherit

EOLE_OLE_WINDOW
redefine
create_ole_interface_ptr,
on_query_interface
end
creation

make
feature

make
--
-- Purpose:
-- Creates an object.
-- 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
-- IOleInPlaceSite interface.
-- Params:
-- None.
-- Return Value:
-- Pointer to created VTBL.
-- Notes:
-- None.
--

can_inplace_activate
--
-- Purpose:
-- Determines whether or not the container can activate
-- the object in place.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--
-- EOLE_S_OK The container allows in-place activation for
-- this object.
-- EOLE_S_FALSE The container does not allow in-place
-- activation for this object.
-- EOLE_E_INVALIDARG One or more arguments are invalid.
-- EOLE_E_UNEXPECTED An unexpected error occurred.
--

on_inplace_activate
--
-- Purpose:
-- Notifies the container that one of its objects is being
-- activated in place.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--
-- EOLE_S_OK The container allows the in-place activation.
-- EOLE_E_UNEXPECTED An unexpected error occurred.
--

on_ui_activate
--
-- Purpose:
-- Notifies the container that the object is about to be activated
-- in place and that the object is going to replace the container's
-- main menu with an in-place composite menu.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--
-- EOLE_S_OK The container allows the in-place activation.
-- EOLE_E_UNEXPECTED An unexpected error occurred.
--

get_window_context: EOLE_WINDOW_CONTEXT
--
-- Purpose:
-- Enables the in-place object to retrieve the window interfaces
-- that form the window object hierarchy, and the position in the
-- parent window where the object's in-place activation window
-- should be placed.
-- Params:
-- None.
-- Return Value:
-- Window context.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--

scroll (cx, cy: INTEGER)
--
-- Purpose:
-- Tells the container to scroll the view of the object by a
-- specified number of pixels.
-- Params:
-- cx: INTEGER [in] Contains the number of pixels by which
-- to scroll in the X directions.
-- cy: INTEGER [in] Contains the number of pixels by which
-- to scroll in the Y directions.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--

on_ui_deactivate (fundoable: BOOLEAN)
--
-- Purpose:
-- Notifies the container on deactivation that it should reinstall
-- its user interface and take focus, and whether or not the
-- object has an undoable state.
-- Params:
-- fUndoable: BOOLEAN [in] Specifies whether the object can undo
-- changes. It is TRUE if the object can
-- undo, FALSE if it cannot.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
--

on_inplace_deactivate
--
-- Purpose:
-- Notifies the container that the object is no longer active
-- in place.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
-- EOLE_S_OK The method successfully notified the container.
-- EOLE_E_UNEXPECTED An unexpected error occurred.
--

discard_undo_state
--
-- Purpose:
-- Tells the container that the object no longer has any undo
-- state and that the container should not call
-- IOleInPlaceObject::ReActivateAndUndo.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
-- EOLE_S_OK The method completed successfully.
-- EOLE_E_UNEXPECTED An unexpected error occurred.
--

deactivate_and_undo
--
-- Purpose:
-- Causes the container to end the in-place session, deactivates
-- the object, and revert to its own saved undo state.
-- Params:
-- None.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
-- EOLE_S_OK The method completed successfully.
-- EOLE_E_UNEXPECTED An unexpected error occurred.
--
--

on_pos_rect_change (posrect: EOLE_RECT)
--
-- Purpose:
-- Indicates the object's extents have changed.
-- Params:
-- PosRect: EOLE_RECT [in] Points to the rectangle containing
-- the position of the in-place object
-- in the client coordinates of its
-- parent window.
-- Return Value:
-- None.
-- Notes:
-- Error code of this operation is available via
-- the 'get_status_code' method.
-- EOLE_S_OK The method completed successfully.
-- EOLE_E_INVALIDARG One or more arguments are invalid.
-- EOLE_E_UNEXPECTED An unexpected error occurred.
--
end -- class EOLE_INPLACE_SITE

INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES