141 lines
10 KiB
HTML
141 lines
10 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html lang="en-us" xml:lang="en-us">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2005" />
|
|
<meta name="DC.rights.owner" content="(C) Copyright IBM Corporation 2005" />
|
|
<meta name="security" content="public" />
|
|
<meta name="Robots" content="index,follow" />
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
|
<meta name="DC.Type" content="concept" />
|
|
<meta name="DC.Title" content="iSeries Navigator COM interfaces for C++" />
|
|
<meta name="abstract" content="The functions implemented by a plug-in logically are grouped into Component Object Model (COM) interfaces." />
|
|
<meta name="description" content="The functions implemented by a plug-in logically are grouped into Component Object Model (COM) interfaces." />
|
|
<meta name="DC.Relation" scheme="URI" content="rzakxplugincplus.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzakxdescia4hierarchy.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzakxia4hierarchyifspec.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzakxdescia4propsheet.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzakxia4propsheetifspec.htm" />
|
|
<meta name="DC.Format" content="XHTML" />
|
|
<meta name="DC.Identifier" content="rzakxcomint" />
|
|
<meta name="DC.Language" content="en-us" />
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
|
<!-- US Government Users Restricted Rights -->
|
|
<!-- Use, duplication or disclosure restricted by -->
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
|
<title>iSeries Navigator COM interfaces for C++</title>
|
|
</head>
|
|
<body id="rzakxcomint"><a name="rzakxcomint"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1">iSeries Navigator COM interfaces for C++</h1>
|
|
<div><p>The functions implemented by a plug-in logically are grouped into <span class="uicontrol">Component Object Model (COM) interfaces</span>.</p>
|
|
<p>An interface is a set of logically related methods on a class that iSeries™ Navigator can call to perform a specific function.
|
|
A plug-in may implement one or more COM interfaces, depending on the type of function that the developer intends to provide. For example, when a user right-clicks an object in the tree hierarchy, iSeries Navigator constructs a context menu for the object and displays the menu on the screen. The Navigator obtains the menu items by calling each
|
|
plug-in that has registered its desire to supply context menu items for the selected object type. The plug-ins pass their menu items to the Navigator when it calls their implementation of the <span class="uicontrol">QueryContextMenu</span> method
|
|
on the <span class="uicontrol">IContextMenu interface</span>.</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e35">Interface</th>
|
|
<th valign="top" id="d0e37">Method</th>
|
|
<th valign="top" id="d0e39">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td rowspan="3" valign="top" headers="d0e35 ">IContextMenu</td>
|
|
<td valign="top" headers="d0e37 ">QueryContextMenu</td>
|
|
<td valign="top" headers="d0e39 ">Supplies context menu items when a user right-clicks on an object.</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e37 ">GetCommandString</td>
|
|
<td valign="top" headers="d0e39 ">Supplies help text for context menu items and, based on the state of the object, also indicates whether the item should be enabled or grayed. </td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e37 ">InvokeCommand</td>
|
|
<td valign="top" headers="d0e39 ">Displays the appropriate dialog and performs the requested action. It's called when the user clicks on a given menu item. </td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e35 "> IPropSheetExt </td>
|
|
<td valign="top" headers="d0e37 ">AddPages</td>
|
|
<td valign="top" headers="d0e39 ">Creates the property page or pages being added by using standard Windows<sup>®</sup> APIs. It then adds the pages by
|
|
calling a function that was passed to it as a parameter.</td>
|
|
</tr>
|
|
<tr><td rowspan="4" valign="top" headers="d0e35 ">IDropTarget</td>
|
|
<td valign="top" headers="d0e37 ">DragEnter</td>
|
|
<td valign="top" headers="d0e39 ">Active when the user drags an object over the drop area.</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e37 ">DragLeave</td>
|
|
<td valign="top" headers="d0e39 ">Active when the user drags an object out of the drop area.</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e37 ">DragOver</td>
|
|
<td valign="top" headers="d0e39 ">Active while the user is over the drop area.</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e37 ">Drop</td>
|
|
<td valign="top" headers="d0e39 ">Active when the user drops the object.</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e35 ">IPersistFile</td>
|
|
<td valign="top" headers="d0e37 ">Load</td>
|
|
<td valign="top" headers="d0e39 ">Called to initialize the extension with the fully qualified object name of the selected folder.</td>
|
|
</tr>
|
|
<tr><td rowspan="2" valign="top" headers="d0e35 ">IA4SortingHierarchyFolder</td>
|
|
<td valign="top" headers="d0e37 ">IsSortingEnabled</td>
|
|
<td valign="top" headers="d0e39 ">Indicates whether sorting is enabled for a folder.</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e37 ">SortOnColumn</td>
|
|
<td valign="top" headers="d0e39 ">Sorts the list on the specified list view column.</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e35 ">IA4FilteringHierarchyFolder</td>
|
|
<td valign="top" headers="d0e37 ">GetFilterDescription</td>
|
|
<td valign="top" headers="d0e39 ">Returns a text description of the current include criteria.</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e35 ">IA4PublicObjectHierarchyFolder</td>
|
|
<td valign="top" headers="d0e37 ">GetPublicListObject</td>
|
|
<td valign="top" headers="d0e39 ">Implemented by a plug-in when it desires to make its list objects available for use by other by other plug-ins</td>
|
|
</tr>
|
|
<tr><td rowspan="2" valign="top" headers="d0e35 ">IA4ListObject</td>
|
|
<td valign="top" headers="d0e37 ">GetAttributes</td>
|
|
<td valign="top" headers="d0e39 ">Returns a list of supported attribute IDs and the type of data associated with each.</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e37 ">GetValue</td>
|
|
<td valign="top" headers="d0e39 ">Given an attribute ID, returns the current value of the attribute.</td>
|
|
</tr>
|
|
<tr><td rowspan="2" valign="top" headers="d0e35 ">IA4TasksManager</td>
|
|
<td valign="top" headers="d0e37 ">QueryTasks</td>
|
|
<td valign="top" headers="d0e39 ">Returns a list of tasks supported by this object</td>
|
|
</tr>
|
|
<tr><td valign="top" headers="d0e37 ">TaskSelected</td>
|
|
<td valign="top" headers="d0e39 ">Informs the IA4TasksManager implementation that a particular task has been selected by the user.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">IA4 interfaces</h4><p>In addition to Microsoft's COM interfaces, IBM<sup>®</sup> supplies the IA4HierarchyFolder and
|
|
IA4PropSheetNotify interfaces.</p>
|
|
<p>IA4PropSheetNotify, notifies third-party property pages when the main dialog closes. It also defines methods that communicate information to the plug-in. For example,
|
|
the method may communicate whether the iSeries user whose properties are being displayed already exists or is being defined,
|
|
and whether changes should be saved or discarded.</p>
|
|
<p>IA4HierarchyFolder allows a plug-in to add new folders to the iSeries Navigator
|
|
hierarchy. The purpose of this interface is to supply the data used to populate the contents of a new folder that your plug-in added to the Navigator hierarchy. It also defines methods for specifying list
|
|
view columns and their headings, and for defining a custom toolbar that is associated with a folder.</p>
|
|
<p>See the following topics for more information:</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<ul class="ullinks">
|
|
<li class="ulchildlink"><strong><a href="rzakxdescia4hierarchy.htm">Description of IA4HierarchyFolder Interface</a></strong><br />
|
|
The IA4HierarchyFolder interface describes a set of functions that the independent software vendor will implement. IA4HierarchyFolder is a component object model (COM) interface that IBM defined for the purpose of allowing third parties to add new folders and objects to the iSeries Navigator hierarchy.</li>
|
|
<li class="ulchildlink"><strong><a href="rzakxia4hierarchyifspec.htm">IA4HierarchyFolder interface specifications listing</a></strong><br />
|
|
An item identifier, or data entity, identifies all folders and
|
|
objects in the Windows namespace. Item identifiers are like filenames
|
|
in a hierarchical file system. The Windows namespace is, in fact, a hierarchical
|
|
namespace with its root at the Desktop.</li>
|
|
<li class="ulchildlink"><strong><a href="rzakxdescia4propsheet.htm">Description of IA4PropSheetNotify interface</a></strong><br />
|
|
Like the IA4HierarchyFolder interface, the IA4PropSheetNotify interface describes a set of functions that the independent software vendor will implement. IA4PropSheetNotify is a COM interface IBM defined to allow third parties to add new property pages to any property sheet that the iSeries Navigator defines for an iSeries server user.</li>
|
|
<li class="ulchildlink"><strong><a href="rzakxia4propsheetifspec.htm">IA4PropSheetNotify interface specifications listing</a></strong><br />
|
|
The IA4PropSheetNotify interface supplies notifications to the implementation of IShellPropSheetExt that are needed when adding additional property pages to one of the Users and Groups property sheets.</li>
|
|
</ul>
|
|
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzakxplugincplus.htm" title="Use the following topics to learn about the flow of control in iSeries Navigator for C++.">C++ Reference</a></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |