All Frameworks Class Hierarchy This Framework Previous Next Indexes
ComponentsCatalogsInterfaces Interface CATICatalogBrowser
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATICatalogBrowser
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICatalogBrowser
Interface to manipulate the Catalog Browser.
Role: The Catalog Browser is a Dialog box to browse and
instantiate component in context.
The CATICatalogBrowserFactory interface enables to create and display an instance of this Dialog box.
This catalog browser will be created inside a
CATCommand. After the creation, you must retrieve the window of the Dialob box, thanks
to the
GetFatherWindow, and sets as parent for this window the command which has instantiate it. It enables to your command to receive the notifications sent by
the Catalog Browser:
and in case of Dialog box closing use the
CloseBrowser to close it. On the catalog browser you can impose to the end user a type of behavior:
The last part concerning the catalog browser is the filtering. You can retrieve the end user filter or
impose it a filtering. There are two kinds of filter:
- The internal filter: you impose it to the end user on a chapter, the end
user cannot change it.
- The end user filter: those enter by the end user in the Filter editor, or
by the
SetCurrentQuery method you can set a end user filter
The filter applied to a chapter is the internal filter and the end user filter.
Method Index
- o
AuthorizeChangeCatalog(int)
- Authorizes or not user to change of current catalog.
- o
AuthorizeDragDrop(int)
- Authorizes the instantiation with drag&drop.
- o
AuthorizeInstantiation(int)
- Authorizes the instantiation with double click or the contextual menu.
- o
BuildCurrentChapterString(CATListOfCATUnicodeString*&)
- Builds a CATUnicodeString to store the current chapter.
- o
CloseBrowser()
- Closes the current browser.
- o
GetCancelNotification(CATNotification*&)
- Retrieves the notification on the "Cancel" button.
- o
GetChangeChapterNotification(CATNotification*&)
- Retrieves the notification when a modification on the current chapter has be done.
- o
GetCloseNotification(CATNotification*&)
- Retrieves the notification when the browser is closed.
- o
GetCurrentCatalogDocId(CATIDocId**)
- Retrieves the current catalog.
- o
GetCurrentCatalogPath(CATUnicodeString&)
-
- o
GetCurrentQueryResult(CATICatalogQueryResult*&)
- Retrieves the current query result.
- o
GetFatherWindow(CATDlgDialog*&)
- Retrieves the window to add notification.
- o
GetOKNotification(CATNotification*&)
- Retrieves the notification on the "OK" button (a final description need to be selected).
- o
GetSelectDescriptionNotification(CATNotification*&)
- Retrieves a notification on the selected description.
- o
GetSelectedDescription(CATICatalogDescription*&)
- Retrieves the selected description.
- o
OKActivationMode(int)
- Activates OK button only for end chapters, not for sub-chapters.
- o
SetCurrentCatalogDocId(CATIDocId*)
- Sets the current catalog.
- o
SetCurrentCatalogPath(CATUnicodeString)
-
- o
SetCurrentChapter(CATICatalogChapter*,int)
- Sets the chapter to activate in the browser.
- o
SetCurrentChapter(CATListOfCATUnicodeString*)
- Sets a current sub-chapter in the catalog browser.
- o
SetCurrentQuery(CATUnicodeString&,int)
- Sets the current query result.
- o
SetSelectedDescription(CATICatalogDescription*)
- Sets the selected description as the current in the browser.
Methods
o AuthorizeChangeCatalog
public virtual HRESULT AuthorizeChangeCatalog( | int | iEnable) = 0 |
-
Authorizes or not user to change of current catalog.
- Parameters:
-
- iEnable
- 0: OK available only for description in end chapters. File Selection Box Icon is Disable.
1: OK available for all description, default mode. File Selection Box Icon is Enable.
o AuthorizeDragDrop
public virtual HRESULT AuthorizeDragDrop( | int | iEnable) = 0 |
-
Authorizes the instantiation with drag&drop.
- Parameters:
-
- iEnable
- If iEnable is 1 then the functionality drag&drop is enable.
Else 0 and the functionality is disable.
Attention, the Drag and Drop is only possible if the current command is the Select
command. So if the catalog browser is launched from a command which is exclusive,
or shared, the instantiation by drag and drop is unavailable.
o AuthorizeInstantiation
public virtual HRESULT AuthorizeInstantiation( | int | iEnable) = 0 |
-
Authorizes the instantiation with double click or the contextual menu.
- Parameters:
-
- iEnable
- 1: instantiation enable, 0: instantiation disable
o BuildCurrentChapterString
-
Builds a CATUnicodeString to store the current chapter.
Role:This method is usefull if you want to be able to reopen Catalog browser with
same chapter. You need to store catalog path (with GetCurrentCatalogDocId) and
chapter path (with BuildCurrentChapterString).
To restore current catalog and chapter, you need to call
SetCurrentCatalogDocId and after
SetCurrentChapter.
- Parameters:
-
- listpath
- A list of string to store and to use in SetCurrentChapter method.
o CloseBrowser
public virtual HRESULT CloseBrowser( | )= 0 |
-
Closes the current browser.
o GetCancelNotification
-
Retrieves the notification on the "Cancel" button.
Available only if browser is built with mode OKCancel
The notification which must be send when the user select the "Cancel" button
o GetChangeChapterNotification
-
Retrieves the notification when a modification on the current chapter has be done.
- Parameters:
-
- oNotif
- The notification which must be send when the user change the current chapter.
o GetCloseNotification
-
Retrieves the notification when the browser is closed.
Available only if browser is built with mode Close
- Parameters:
-
- oNotif
- The notification which must be send when the user close the panel.
- Returns:
- Error code of function.
o GetCurrentCatalogDocId
-
Retrieves the current catalog.
- Parameters:
-
- oDocId
- The current Catalog docid
o GetCurrentCatalogPath
-
- Deprecated:
- V5R15
use GetCurrentCatalogDocId
o GetCurrentQueryResult
-
Retrieves the current query result.
- Parameters:
-
- oQueryresult
- [out, CATBaseUnknown#Release] The current query result which is displayed.
o GetFatherWindow
-
Retrieves the window to add notification.
- Parameters:
-
- oWindow
- The current CATDlgDialog of browser.
o GetOKNotification
-
Retrieves the notification on the "OK" button (a final description need to be selected).
Available only if browser is built with mode OKCancel
- Parameters:
-
- oNotif
- The notification which must be send when the user select the "OK" button.
o GetSelectDescriptionNotification
-
Retrieves a notification on the selected description.
- Parameters:
-
- oNotif
- The notification which must be send when the user select a description (in the case of end-chapter only).
o GetSelectedDescription
-
Retrieves the selected description.
- Parameters:
-
- oDesc
- [out, CATBaseUnknown#Release] The selected description.
o OKActivationMode
public virtual HRESULT OKActivationMode( | int | iEnable) = 0 |
-
Activates OK button only for end chapters, not for sub-chapters.
- Parameters:
-
- iEnable
- 1: OK available for all description, default mode
0: OK available only for description in end chapters.
o SetCurrentCatalogDocId
-
Sets the current catalog.
- Parameters:
-
- oDocId
- The current Catalog docid
o SetCurrentCatalogPath
-
- Deprecated:
- V5R15
use SetCurrentCatalogDocId
o SetCurrentChapter
-
Sets the chapter to activate in the browser.
- Parameters:
-
- iChapter
- The chapter to activate. It must be a chapter of the current CATICatalogQueryResult.
- iSendevent
- Send a event for updating the browser.
o SetCurrentChapter
-
Sets a current sub-chapter in the catalog browser.
- Parameters:
-
- Chapter
- The list of string describing the current chapter.
o SetCurrentQuery
-
Sets the current query result.
- Parameters:
-
- iQuery
- Add your own query
- iUserquery
- A user query is displayed in the browser, user can modify it.
An internal quey allow you to hide some descriptions.
o SetSelectedDescription
-
Sets the selected description as the current in the browser.
- Parameters:
-
- iDesc
- The selected description.
This object is included in the file: CATICatalogBrowser.h
If needed, your Imakefile.mk should include the module: CATCclInterfaces