INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES

indexing

title: "EOLE_INPLACE_FRAME", "The IOleInPlaceFrame interface controls the container%'s", "top-level frame window. This control involves allowing the", "container to insert its menu group into the composite menu,", "install the composite menu into the appropriate window frame,", "and remove the container%'s menu elements from the composite", "menu. It sets and displays status text relevant to the in-place", "object. It also enables or disables the frame%'s modeless dialog", "boxes, and translates accelerator keystrokes intended for the", "container%'s frame."
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_FRAME
inherit

EOLE_INPLACE_UI_WINDOW
redefine
create_ole_interface_ptr,
on_query_interface
end
creation

make
feature

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

insert_menus (menushared: INTEGER; menuwidths: EOLE_MENUGROUPWIDTHS)
--
-- Purpose:
-- Allows the container to insert its menu groups into the
-- composite menu to be used during the in-place session.
-- Params:
-- menuShared: INTEGER [in] Specifies a handle to an
-- empty menu.
-- menuWidths: EOLE_MENUGROUPWIDTHS [in] Points to an
-- EOLE_MENUGROUPWIDTHS array
-- of six LONG values.
-- The container fills in
-- elements 0, 2, and 4 to
-- reflect the number of
-- menu elements it provided
-- in the File, View, and
-- Window menu groups.
-- Return Value:
-- None.
--
-- Notes:
-- None.
--

set_menu (menushared, olemenu, activeobjecthwnd: INTEGER)
--
-- Purpose:
-- Installs the composite menu in the window frame containing
-- the object being activated in place.
-- Params:
-- menuShared: INTEGER [in] Specifies a handle to the
-- composite menu constructed by
-- calls to
-- IOleInPlaceFrame::InsertMenus
-- and the Windows InsertMenu
-- function.
-- oleMenu: INTEGER [in] Specifies the handle to the menu
-- descriptor returned by the
-- OleCreateMenuDescriptor function.
-- activeObjectHwnd: INTEGER [in] Specifies a handle to a window
-- owned by the object and to which
-- menu messages, commands, and
-- accelerators are to be sent.
--
-- Return Value:
-- None.
--
-- Notes:
-- None.
--

remove_menus (menushared: INTEGER)
--
-- Purpose:
-- Gives the container a chance to remove its menu elements from
-- the in-place composite menu.
-- Params:
-- mwnuShared: INTEGER [in] Specifies a handle to the in-place
-- composite menu that was constructed by
-- calls to IOleInPlaceFrame::InsertMenus
-- and the Windows InsertMenu function.
--
-- Return Value:
-- None.
-- Notes:
-- None.
--

set_status_text (statustext: STRING)
--
-- Purpose:
-- Sets and displays status text about the in-place object in the
-- container's frame window status line.
-- Params:
-- StatusText: STRING [in] Character string containing the message
-- to display.
--
-- Return Value:
-- None.
-- Notes:
-- None.
--

enable_modeless (enable: BOOLEAN)
--
-- Purpose:
-- Enables or disables a frame's modeless dialog boxes.
-- Params:
-- Enable: BOOLEAN [in] Specifies whether the modeless dialog
-- boxes are to be enabled by specifying
-- TRUE or disabled by specifying FALSE.
--
-- Return Value:
-- None.
-- Notes:
-- None.
--

translate_accelerator (msg: EOLE_MESSAGE; commandid: INTEGER)
--
-- Purpose:
-- Translates accelerator keystrokes intended for the container's
-- frame while an object is active in place.
-- Params:
-- msg: EOLE_MESSAGE [in] Points to an MSG structure
-- containing the keystroke message.
-- commandID: INTEGER [in] Contains the command identifier
-- value corresponding to the
-- keystroke in the container-provided
-- accelerator table. Containers
-- should use this value instead of
-- translating again.
-- Return Value:
-- None.
-- Notes:
-- None.
--

OleCreateMenuDescriptor (hmenucombined: INTEGER; lpmenuwidths: POINTER): INTEGER
--
-- Purpose:
-- Creates and returns an OLE menu descriptor (that is, an
-- OLE-provided data structure that describes the menus)
-- for OLE to use when dispatching menu messages and commands.
-- Params:
-- hmenuCombined: INTEGER [in] Specifies a handle to the combined
-- menu created by the object.
-- lpMenuWidths: POINTER [in] Points to an array of six LONG
-- values giving the number of menus
-- in each group.
-- Return Value:
-- Returns the handle to the descriptor, or 0 if insufficient
-- memory is available.
-- Notes:
-- None.
--

OleSetMenuDescriptor (holemenu, hwndframe, hwndactiveobject: INTEGER; lpframe, lpactiveobject: POINTER): INTEGER
--
-- Purpose:
-- Installs or removes OLE dispatching code from the container's
-- frame window.
-- Params:
-- hOleMenu: INTEGER [in] Specifies the handle to the
-- composite menu descriptor
-- returned by the
-- OleCreateMenuDescriptor function.
-- If 0, the dispatching code is
-- unhooked.
-- hwndFrame: INTEGER [in] Specifies the handle to the
-- container's frame window where
-- the in-place composite menu is
-- to be installed.
-- hwndActiveObject: INTEGER [in] Specifies the handle to the
-- object's in-place activation
-- window. OLE dispatches menu
-- messages and commands to this
-- window.
-- lpFrame: POINTER [in] IOleInPlaceFrame pointer to the
-- container's frame window.
-- (Can be obtained by the
-- get_ole_interface_ptr method.)
-- lpActiveObject: POINTER [in] IOleInPlaceActiveObject pointer
-- to the active in-place object.
-- Return Value:
-- OLE error code (HRESULT)
-- Notes:
-- None.
--

OleDestroyMenuDescriptor (holemenu: INTEGER)
--
-- Purpose:
-- Called by the container to free the shared menu descriptor
-- allocated by the OleCreateMenuDescriptor function.
-- Params:
-- hOleMenu: INTEGER [in] Specifies a handle to the shared menu
-- descriptor that was returned by the
-- OleCreateMenuDescriptor function.
-- Return Value:
-- None.
-- Notes:
-- None.
--
end -- class EOLE_INPLACE_FRAME

INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES