API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

AEECLSID_WINDOWHISTORY

Brew Release
Brew MP 1.0.2
See Also
IWindowHistory IWindowMgr AEEWindowMgrExtProps.idl
Description
This class provides an implementation of IWindowHistory.
IWindowHistory_GetWinIDs() search criteria:
The general form of the search criteria is: "display=,state=,appclsid=,parentid=,class="
Each case-sensitive term is optional and the relative order of each term is not significant. Any additional whitespace is not permitted. Specifying two or more terms behaves as a logical AND of the terms: returned window IDs will match all the terms.
The "display=" term restricts the search to the specified display. is a decimal or hexadecimal encoding of the desired display (see AEEWindowMgrExtProp_DISPLAY). If this term is not provided, the default/primary display will be searched.
The "state=" term restricts the search to windows with the specified state. is a decimal number with the same values as the AEEWindowMgrExt_PROPEX_STATE property. If the term is not provided, windows in all states will be searched.
The "appclsid=" term restricts the search to windows owned by the specified applet. is a decimal or hexadecimal encoding of the desired app classID to search. If the term is not provided, windows owned by all applets will be searched.
The "parentid=" term restricts the search to windows that have the specified winID as parent. If winID is not specified ("parent="), the search is restricted to windows without a parent. If the term is not provided, windows with or without a parent will be searched.
The "class=" term restricts the search to windows of that class. is a decimal or hexadecimal encoding of the desired window class. For example, for AEEWindowMgrExt_CLASS_Fullscreen use "class=0x00000001". If the term is not provided all fullscreen and popups will be searched.
The window IDs returned by IWindowHistory_GetWinIDs() are always in decreasing Z-order, the first window ID in the returned list being the top-most window that matches the search criteria.
Please note that additional terms and/or values may be added in the future, so all strings that do not conform to the above format are considered reserved for future use.

Information retrievable by IWindowHistory_GetWinInfo()
The following information may be retrieved using the IWindowHistory_GetWinInfo() method. The keys are case-sensitive.
Key Value Format Description ------------------------------------------------------------------------
"state" The current state of the window. (same values as AEEWindowMgrExt_PROPEX_STATE) "appclsid" The class ID of the applet that created this window "display" The display associated with this window (see AEEWindowMgrExtProp_DISPLAY) "parentid" The parent window ID of this window (see AEEWindowMgrExtProp_PARENTID) "class" The class of this window (see AEEWindowMgrExtProp_CLASS) "prevwinid" The window ID of the fullscreen/pop-up window beneath this window "nextwinid" The window ID of the fullscreen/pop-up window above this window "rect" The current display rectangle of the window: "title" The title of this window "focus" The current focus status of the window User defined properties can be retrieved. Example key: "0xFFFFFFFF"
Value Formats ------------------------------------------------------------------------
=> A 32-bit signed decimal number with no leading/trailing whitespace => Four values separated by a comma: ",,," => String in UTF8 format => Sequence of bytes represented as a string of hex numbers: "1F125D2" => Either "1" for true or "0" for false
IWindowHistory_OnChange() notification criteria:
The general form of the notification criteria is: "display=,state="
The meaning and behavior of these two terms is the same as the corresponding IWindowHistory_GetWinIDs() search criteria.
Default Interface Name