The IHelpWindow class provides help for application windows that use Information Presentation Facility (IPF) and for native help on the Windows platform. Typically, you create an IHelpWindow object and associate it with the primary windows of your application. Multiple IPF help windows can also exist within an application. When an application window is associated with a help window, help events are dispatched to the help handler attached to the associated application window.
The class default style for the IHelpWindow class is different in the Windows environment. In the OS/2 and AIX environments, the default is set to IHelpWindow::ipfCompatible and cannot be changed. In the Windows environment, the default is set for native Windows help. You can change the default to IHelpWindow::ipfCompatible style by calling IHelpWindow::setDefaultStyle.
When using the native Windows help, many of the IHelpWindow methods, for example IHelpWindow::hidePanelIds, perform no other function than to return a reference to the IHelpWindow object or null. Also, because native Windows help does not send messages back to the application, most of the IHelpHandler functions are never called. For more details, see the function descriptions for the IHelpWindow and IHelpHandler classes.
You can build the viewable help files for your AIX application using the Information Presentation Facility compiler (IPFC) that comes with the Developer's Toolkit for OS/2, version 2.1 or later.
Instead of compiling an IPF file using code page 437, as you would to view help on the OS/2 platform, you must compile the file on the OS/2 platform using code page 850 to view the help on AIX.
IHelpWindow uses the window identifier of the IWindow object as the identifier of the contextual or general help panel to display.
By default, IHelpWindow objects constructed in the Windows environment use native Windows help. To prepare your program to use this style of help, you build a .hlp file using the Windows help compiler from a source file written in Rich Text Format (RTF) and then access the help file using the portable IHelpWindow classes. This approach gives you the ability to port your application code while providing your users with native look-and-feel when using help. However, you should note the following differences in IHelpWindow behavior.
If you prefer to show help using IPF on Windows, set the default IHelpWindow style before constructing the IHelpWindow object. You do this using the static IHelpWindow function:
IHelpWindow::setDefaultStyle(IHelpWindow::ipfCompatible);
You can also set the help window style by specifying the appropriate style on the IHelpWindow constructor.
You can construct and destruct objects of this class. You cannot copy or assign IHelpWindow objects because both the copy constructor and assignment operator are private functions.
![]() |
public:
virtual ~IHelpWindow()
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
IHelpWindow( const IResourceId& helpTable, IFrameWindow* associatedWindow, const IHelpWindow::Style& style = defaultStyle ( ) )
For you to provide an application window with contextual or general help using help tables, the window must be an associated window, have an associated window in its parent window chain, or be a secondary window owned by an associated window. IPF also sends help notification events to associated frame windows, positions the help window to minimally overlap an associated frame window, closes the help window when the associated frame window is closed, and activates the associated frame window when the user dismisses the help window.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
IHelpWindow( IFrameWindow* associatedWindow = 0, const IHelpWindow::Style& style = defaultStyle ( ) )
For you to provide an application window with contextual or general help using help tables, the window must be an associated window, have an associated window in its parent window chain, or be a secondary window owned by an associated window. IPF also sends help notification events to associated frame windows, positions the help window to minimally overlap an associated frame window, closes the help window when the associated frame window is closed, and activates the associated frame window when the user dismisses the help window.
If you do not specify an application frame window to be associated with the help window object, you can later call the function IHelpWindow::setAssociatedWindow to make this association.
IAccessError | Information Presentation Facility (IPF) could not create the help window. |
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
IHelpWindow( const Settings& settings, IFrameWindow* associatedWindow = 0, const IHelpWindow::Style& style = defaultStyle ( ) )
For you to provide an application window with contextual or general help using help tables, the window must be an associated window, have an associated window in its parent window chain, or be a secondary window owned by an associated window. IPF also sends help notification events to associated frame windows, positions the help window to minimally overlap an associated frame window, closes the help window when the associated frame window is closed, and activates the associated frame window when the user dismisses the help window.
You can also call the function IHelpWindow::setAssociatedWindow to associate a frame window with the IHelpWindow object.
This is the most flexible IHelpWindow constructor because the IHelpWindow::Settings class allows you to specify a wide amount of information, including a tutorial, menu bar, and accelerator table, for which the IHelpWindow class does not provide member functions.
IAccessError | Information Presentation Facility (IPF) could not create the help window. |
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
IHelpWindow(const IWindowHandle& helpWindowHandle)
Only this constructor allows you to create an IHelpWindow object for an existing help window. All other constructors create a help window.
IInvalidParameter | helpWindowHandle is 0. It must be a valid window handle. |
Windows | OS/2 | AIX |
Yes | Yes | Yes |
You can use the same IHelpWindow object to service help requests for many application windows created in the same thread, regardless of whether they are primary, secondary, or child frame windows. You can control the help subtable that IPF uses to display contextual help by managing the active window, control where IPF positions a help panel by managing the relative window, and control the owner window of a help panel by managing the associated window.
![]() |
public:
virtual IHelpWindow& setActiveWindow( IFrameWindow* activeWindow, IFrameWindow* relativeWindow = 0 )
Sets the application window from which IPF expects subsequent requests for contextual or general help. With this function, you can enable IPF to display contextual and general help panels for a child frame window using help tables and subtables. For this case, IPF would otherwise treat the parent frame window as the active window.
Optionally, you can specify the window to position the help window next to.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), you can still use this function to control which help subtable to use when displaying contextual or general help. However, since there is only one native Windows help instance per system, the help window is not positioned relative to your application's window. Therefore, for native Windows help, setting the second parameter will have no effect.
![]() |
public:
virtual IHelpWindow& setAssociatedWindow( IFrameWindow* associatedWindow )
Associates an application frame window with the help window. More than one window can be associated with a help window.
For you to provide an application window with contextual or general help using help tables, the window must be an associated window, have an associated window in its parent window chain, or be a secondary window owned by an associated window. IPF also sends help notification events to associated frame windows, positions the help window to minimally overlap an associated frame window, closes the help window when the associated frame window is closed, and activates the associated frame window when the user dismisses the help window.
This function allows you to use the same help window for multiple primary windows. Additionally, you can better manage help windows for a secondary frame window. This might be necessary if a primary window would otherwise be the associated window. By making a secondary frame window the associated window you get these results:
A frame window is automatically disassociated from a help window when it closes.
IInvalidParameter | associatedWindow is 0. It must be a valid window handle. |
IAccessError | Information Presentation Facility (IPF) could not associate the specified window with the help window. Possibly associatedWindow does not represent a valid window. |
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Most of the help information that a user sees is typically in the form of help panels.You can direct IPF to display help panels for contextual and general help based on a help table. You can also show specialized help panels or help windows programmatically, independent of help tables.
![]() |
public:
virtual IHelpWindow& addLibraries( const char* helpLibraryNames )
Adds a library or list of libraries to those already used by IPF. IPF searches these help libraries for the help panels that it displays. This function deals with binary help files that have an .hlp extension.
IInvalidRequest | Information Presentation Facility (IPF) is unable to add the specified help libraries. Possibly it could not open the help library files. |
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you want to use the HELP Setting to search for the help library files, specify the file names without a directory or path.
When using the native Windows help style for IHelpWindow objects, you should only pass a single file name on the addLibraries call. The filename should identify the help file that was compiled with the Windows help compiler from a Rich Text Format (RTF) source file.
![]() |
public:
virtual IHelpWindow& hide()
Closes the help window.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IHelpWindow& setHelpTable( const IResourceId& helpTable )
Sets the help table for IPF to use for satisfying user requests for contextual and general help. Entries in the help table identify the help panel to be searched for in the help libraries, for a given application frame window or control.
This function replaces any help table identified with the class IHelpWindow::Settings.
You can also associate help panels with IWindow or IMenu item objects directly by calling IWindow::setHelpId or IMenu::setItemHelpId.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IHelpWindow& setUsingHelp(unsigned long panelId)
Sets the help panel to use instead of the default Using Help panel provided by IPF. Calling IHelpWindow::show and specifying IHelpWindow::usingHelp causes IPF to show this help panel.
This function replaces any Using Help panel identified with the class IHelpWindow::Settings.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), this function will change the help panel that is displayed when calling IHelpWindow::show with the HelpType of usingHelp.
![]() |
Displays a help panel or specialized help window.
public:
virtual IHelpWindow& show(HelpType helpType)
The enumerator identifies a help panel or kind of help window.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), the HelpType enumeration values have different meanings.
public:
virtual IHelpWindow& show(const IResourceId& panelId)
If you specify an identifier of 0,
the Using Help window is displayed.
Note:
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
virtual IHelpWindow& show(const char* panelName)
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), this function calls Windows help, using the panel name as a keyword.
You can uniquely identify a help panel by its help panel identifier. You can have help panels display their panel IDs for diagnostic purposes.
![]() |
public:
virtual IHelpWindow& hidePanelIds()
Removes the identifier for a help panel from its title bar text.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), this function has no effect.
![]() |
public:
virtual IHelpWindow& showPanelIds(bool visibleId = true)
Adds the identifier for a help panel to its title bar text.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), this function has no effect.
Event send and post members are overridden to ensure events get routed to the correct window.
![]() |
Sends the specified event to the help window.
public:
virtual IEventResult sendEvent(const IEvent& event) const
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
virtual IEventResult sendEvent( unsigned long eventId, const IEventParameter1& parm1 = 0, const IEventParameter2& parm2 = 0 ) const
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
virtual IEventResult sendEvent( EventType eventType, const IEventParameter1& parm1 = 0, const IEventParameter2& parm2 = 0 ) const
Windows | OS/2 | AIX |
Yes | Yes | Yes |
IHelpWindow defines objects of the nested class IHelpWindow::Style. You can use these styles with IHelpWindow::setDefaultStyle.
![]() |
public:
static Style defaultStyle()
Returns the default style. This style is equivalent to IHelpWindow::classDefaultStyle unless you have changed the style using IHelpWindow::setDefaultStyle.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
bool isIPFCompatible() const
Returns true if the IPF is being used to display application help information. True is always returned, except on Windows where true means IPF is being used and false means that native Windows help is being used.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static void setDefaultStyle(const Style& style)
Sets the default style for construction of all subsequent help windows. You only need this function in the Windows environment and then only if you want to change which help manager you want to use to process application help requests.
This member function is not thread safe. In a multithreaded application, it should only be called when a conflict is not possible. A conflict can arise if you set the default style on one thread at the same time that it is being queried on another. In this situation, the query would take place while the style is in an unknown state.
When you create a window class and do not specifically specify window styles in the constructor, the Open Class Library queries the default style. Therefore, the only safe place to call this member function is when no other application threads that create windows are active.
Another way to avoid a conflict in a multithreaded application is to specifically specify window styles on window construction, rather than calling this member function.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
To change from native Windows help to IPF help, use:
setDefaultStyle(IHelpWindow::ipfCompatible).
To change from IPF help to native Windows help, use: setDefaultStyle(~IHelpWindow::ipfCompatible).
![]() |
public:
static const Style classDefaultStyle
Specifies the original default style for this class, which is IHelpWindow::ipfCompatible, except on Windows where it is set to IHelpWindow::noStyle, meaning native Windows help.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static const Style ipfCompatible
Specifies that IHelpWindow should use IPF to display application help information. Except for the Windows environment, this style is always on. For Windows, the default is IHelpWindow::noStyle, therefore native Windows help is used. To use IPF on Windows, call IHelpWindow::setDefaultStyle with this style before constructing your IHelpWindow object or specify this style on the IHelpWindow constructor.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static const Style noStyle
You use this style in the Windows environment to specify that native Windows help should be used to show help information. You only need to use this style if you have previously changed the default style to ipfCompatible. You change your default IHelpWindow style by calling, IHelpWindow::setDefaultStyle.
In all other environments, using this style has no effect.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
The IHelpWindow class allows you to control the text displayed in the title bar of the cover page window.
![]() |
Sets the title bar text for the help window.
These functions replace any title identified with the class IHelpWindow::Settings.
public:
virtual IHelpWindow& setTitle(const IResourceId& titleId)
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), this function has no effect.
public:
virtual IHelpWindow& setTitle(const char* titleText)
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), this function has no effect.
Many different help-related windows can be displayed during the course of an application. You can access the different types of windows to provide application-specific processing or customization.
![]() |
public:
IWindowHandle communicationWindow() const
Returns the handle of the active communication window.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), this function has no effect.
![]() |
public:
IWindowHandle contentsWindow() const
Returns the handle of the Table of Contents window.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), this function has no effect.
![]() |
public:
IWindowHandle coverPageWindow() const
Returns the handle of the IPF multiple-document-interface parent window. This is the window within which all other IPF windows are displayed.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), this function has no effect.
![]() |
public:
virtual IWindowHandle handle() const
Returns the handle of the help window.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), a unique window handle is returned, butsince native Windows help provides only one help instance per system, the handle provides no other purpose than unique identification.
![]() |
public:
static IHelpWindow* helpWindow(const IWindow* window)
Returns the help window that is associated with the specified application window. The parent window chain is searched until an application window associated with a help window is found, in which case this function returns that help window. If a help window cannot be found, 0 is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
IWindowHandle indexWindow() const
Returns the handle of the Index window.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), this function has no effect.
![]() |
public:
IWindowHandle searchListWindow() const
Returns the handle of the Search window.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), this function has no effect.
![]() |
public:
IWindowHandle viewedPagesWindow() const
Returns the handle of the Viewed Pages window.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), this function has no effect.
The IHelpWindow class allows you to size and position the cover page window, within which all other IPF windows are displayed.
![]() |
public:
virtual IHelpWindow& moveSizeTo( const IRectangle& rectangle )
Changes the size and position of the help cover page window, within which all other IPF windows are displayed.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), this function will move and size the single system instance of native Windows help.
![]() |
public:
virtual IHelpWindow& moveTo(const IPoint& point)
Changes the position of the help cover page window, within which all other IPF windows are displayed. Call this function only when the help window is visible.
IInvalidRequest | The help window is not visible. |
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), this function has no effect. You can use IHelpWindow::moveSizeTo to change both the size and position of the single native Windows help instance.
![]() |
public:
virtual IHelpWindow& sizeTo(const ISize& size)
Changes the size of the help cover page window, within which all other IPF windows are displayed. Call this function only when the help window is visible.
IInvalidRequest | The help window is not visible. |
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help (that is, you did not construct your IHelpWindow object with the IHelpWindow::ipfCompatible style), this function has no effect. You can use IHelpWindow::moveSizeTo to change both the size and position of the single native Windows help instance.
![]() |
enum HelpType { index, general, contents, keys, usingHelp, using=usingHelp }
Use these enumerators to identify a type of help window or help panel:
Windows | OS/2 | AIX |
Yes | Yes | Yes |
If you are using native Windows help, HelpType values have the following meanings:
virtual ~INotifier()
virtual INotifier& disableNotification() = 0
virtual INotifier& enableNotification( bool enable = true ) = 0
INotifier()
virtual bool isEnabledForNotification() const = 0
virtual INotifier& notifyObservers( const INotificationEvent& event ) = 0
virtual INotifier& notifyObserversAsync( const INotificationEvent& event )
const IThreadId& threadId() const
virtual ~IWindow()
IAccelTblHandle acceleratorHandle() const
IAcceleratorTable acceleratorTable() const
virtual IColor activeColor() const
IWindow& addOrReplaceAttribute( const IAttributeName& name, const IAttribute& attribute )
IWindow& adoptWindowData( const DataHandle& typeToken, IWindowData* windowData )
virtual IString asDebugInfo() const
virtual IString asString() const
IAttributeName attributeNameAt( const AttributeCursor& cursor ) const
const IAttribute* attributeWithName( const IAttributeName& name, ESearchType search = kWindowOnly ) const
virtual IColor backgroundColor() const
virtual IWindow& capturePointer(bool capture = true)
ISize characterSize() const
IWindowHandle childAt(const ChildCursor& cursor) const
IWindow* childWindowAt(const ChildCursor& cursor) const
virtual IArgList convertToArgList( const IBitFlag& style ) const
virtual unsigned long convertToGUIStyle( const IBitFlag& style, bool extendedOnly = false ) const
static DataHandle dataHandleWithKey( const char* dataKeyName )
virtual IWindowHandle defaultEmphasisButton() const
static SiblingOrder defaultOrdering()
virtual IWindowHandle defaultPushButton() const
static IWindow* desktopWindow()
virtual IWindow& disable()
virtual IColor disabledBackgroundColor() const
virtual IColor disabledForegroundColor() const
virtual IWindow& disableGroup()
IWindow& disableMinimumSizeCaching()
virtual IWindow& disableNotification()
virtual IWindow& disableTabStop()
virtual IWindow& disableUpdate()
bool dispatchRemainingHandlers( IEvent& event, bool callDefProc = true )
virtual IWindow& enable(bool enableWindow = true)
virtual IWindow& enableGroup(bool enable = true)
IWindow& enableMinimumSizeCaching( bool enableCaching = true )
virtual IWindow& enableNotification(bool enable = true)
virtual IWindow& enableTabStop(bool enable = true)
virtual IWindow& enableUpdate(bool enableWindow = true)
static IWindow::ExceptionFn* exceptionFunction()
virtual IFont font() const
virtual IColor foregroundColor() const
virtual bool handleException( IException& dispatcherException, IEvent& exceptionEvent )
virtual IWindowHandle handleForChildCreation() const
static IWindowHandle handleWithParent( unsigned long identifier, const IWindowHandle& parent )
static IWindowHandle handleWithPointerCaptured()
virtual bool hasFocus() const
virtual bool hasPointerCaptured() const
unsigned long helpId() const
virtual IWindow& hide()
virtual IWindow& hideSourceEmphasis()
virtual IColor hiliteBackgroundColor() const
virtual IColor hiliteForegroundColor() const
virtual unsigned long id() const
virtual IColor inactiveColor() const
virtual IRectangle invalidatedRect() const
virtual IRegionHandle invalidatedRegion() const
bool isAutoDeleteObject() const
bool isAutoDestroyWindow() const
bool isEnabled() const
virtual bool isEnabledForNotification() const
virtual bool isFrameWindow() const
virtual bool isGroup() const
bool isHandling(const EventMask& events) const
virtual bool isLayoutDistorted( unsigned long layoutAttribute ) const
bool isMinimumSizeCachingEnabled() const
bool isShowing() const
virtual bool isTabStop() const
bool isUpdateEnabled() const
virtual bool isValid() const
bool isVisible() const
static bool isWindowValid(const IWindow* window)
IDMItemProvider* itemProvider() const
IWindow(const IWindowHandle& handle)
IWindow(unsigned long identifier, IWindow* parent)
virtual IRectangle layoutAdjustment() const
static IPoint mapPoint( const IPoint& point, const IWindowHandle& from, const IWindowHandle& to )
virtual IWindowHandle matchForMnemonic( unsigned short character ) const
IMessageQueueHandle messageQueue() const
ISize minimumSize(bool windowCalculatedSize = false) const
virtual IPointerHandle mousePointer() const
static void movePointerTo(const IPoint& position)
virtual IWindow& moveSizeTo( const IRectangle& newSizeAndPosition )
virtual IWindow& moveTo(const IPoint& newPosition)
virtual IRectangle nativeRect() const
virtual INotifierAddress notifierAddress() const
virtual IWindow& notifyObservers( const INotificationEvent& event )
virtual IWindow& notifyObserversAsync( const INotificationEvent& event )
static IWindow* objectWindow()
virtual IWindow* owner() const
IWindow* parent() const
virtual ISize parentSize() const
static ISize parentSize(const IWindowHandle& windowHandle)
static IPoint pointerPosition()
virtual IPoint position() const
virtual IWindow& positionBehindSibling( const IWindowHandle& siblingWindow )
virtual IWindow& positionBehindSiblings()
virtual IWindow& positionOnSiblings()
virtual const IWindow& postEvent(const IEvent& event) const
virtual const IWindow& postEvent( EventType eventType, const IEventParameter1& parm1 = 0, const IEventParameter2& parm2 = 0 ) const
virtual const IWindow& postEvent( unsigned long eventId, const IEventParameter1& parm1 = 0, const IEventParameter2& parm2 = 0 ) const
virtual IPresSpaceHandle presSpace() const
virtual IRectangle rect() const
virtual IWindow& refresh( const IRectangle& invalidRectangle, bool immediate = false )
virtual IWindow& refresh(RefreshType type = paintAll)
virtual IWindow& releasePointer()
virtual void releasePresSpace( const IPresSpaceHandle& presentationSpaceHandle ) const
IWindow& removeAllAttributes()
IWindow& removeAttribute(const IAttributeName& name)
virtual IWindow& resetActiveColor()
virtual IWindow& resetBackgroundColor()
virtual IWindow& resetDisabledBackgroundColor()
virtual IWindow& resetDisabledForegroundColor()
virtual IWindow& resetFont()
virtual IWindow& resetForegroundColor()
virtual IWindow& resetHiliteBackgroundColor()
virtual IWindow& resetHiliteForegroundColor()
virtual IWindow& resetInactiveColor()
IWindow& resetMinimumSize()
virtual IWindow& resetShadowColor()
IWindow& setAcceleratorHandle( const IAccelTblHandle& handle )
IWindow& setAcceleratorTable( const IAcceleratorTable* acceleratorTable )
virtual IWindow& setActiveColor(const IColor& color)
IWindow& setAutoDeleteObject(bool autoDelete = true)
IWindow& setAutoDestroyWindow(bool autoDestroy = false)
virtual IWindow& setBackgroundColor(const IColor& color)
static void setDefaultOrdering(SiblingOrder order)
virtual IWindow& setDisabledBackgroundColor( const IColor& color )
virtual IWindow& setDisabledForegroundColor( const IColor& color )
static IWindow::ExceptionFn* setExceptionFunction( IWindow::ExceptionFn* exceptionFunction )
virtual IWindow& setFocus()
virtual IWindow& setFont(const IFont& font)
virtual IWindow& setForegroundColor(const IColor& color)
IWindow& setHelpId(unsigned long helpTopicId)
virtual IWindow& setHiliteBackgroundColor( const IColor& color )
virtual IWindow& setHiliteForegroundColor( const IColor& color )
virtual IWindow& setId(unsigned long newIdentifier)
virtual IWindow& setInactiveColor(const IColor& color)
IWindow& setItemProvider(IDMItemProvider* dragProvider)
virtual IWindow& setLayoutDistorted( unsigned long layoutAttributesOn, unsigned long layoutAttributesOff )
IWindow& setMinimumSize(const ISize& size)
virtual IWindow& setMousePointer( const IPointerHandle& mousePointer )
virtual IWindow& setOwner(const IWindow* newOwner)
virtual IWindow& setParent(const IWindow* newParent)
virtual IWindow& setShadowColor(const IColor& color)
virtual IColor shadowColor() const
virtual IWindow& show(bool showWindow = true)
virtual IWindow& showSourceEmphasis(bool show = true)
virtual ISize size() const
virtual IWindow& sizeTo(const ISize& newSize)
IWindow& startHandling(const EventMask& events)
IWindow& stopHandling(const EventMask& events)
virtual IWindow& validateRect( const IRectangle& validatedRectangle )
virtual IWindow& validateRegion( const IRegionHandle& validatedRegion )
virtual IRectangle visibleRectangle() const
IWindowData* windowData(const DataHandle& typeToken) const
static IWindow* windowWithHandle( const IWindowHandle& windowHandle, bool allThreads = true )
static IWindow* windowWithOwner( unsigned long identifier, const IWindow* owner, bool allThreads = true )
static IWindow* windowWithParent( unsigned long identifier, const IWindow* parent, bool allThreads = true )
static INotificationId const activeColorId
static const EventMask allMouseMoves
static INotificationId const attributeAddReplaceId
static INotificationId const attributeRemoveId
static INotificationId const backgroundColorId
static INotificationId const borderColorId
static const Style clipChildren
static const Style clipSiblings
static const Style clipToParent
static INotificationId const commandId
static const Style disabled
static INotificationId const disabledBackgroundColorId
static INotificationId const disabledForegroundColorId
static INotificationId const enableId
static INotificationId const focusId
static INotificationId const fontId
static INotificationId const foregroundColorId
static const Style group
static INotificationId const hiliteBackgroundColorId
static INotificationId const hiliteForegroundColorId
static INotificationId const inactiveColorId
static const Style leftToRight
static const EventMask mouseEntersLeaves
static INotificationId const positionId
static const Style rightToLeft
static const Style saveBits
static INotificationId const shadowColorId
static INotificationId const sizeId
static const EventMask someMouseMoves
static const Style synchPaint
static INotificationId const systemCommandId
static const Style tabStop
static const Style visible
static INotificationId const visibleId
static INotificationId const allChangesId
static INotificationId const deleteId
IWindow& addHandler(IHandler* newHandler)
virtual IWindow& addObserver( IObserver& observer, const IInterest& interest )
static void addToWindowSet( IWindow* window, const IWindowHandle& windowHandle )
IWindow& bindMessageQueue(bool bindToMessageQueue = true)
virtual ISize calcMinimumSize() const
IColor color( unsigned long colorArea, const IColor& defaultColor ) const
IColor color(unsigned long colorArea) const
virtual IWindowHandle create( unsigned long id, const char* text, unsigned long style, const char* windowClass, const IWindowHandle& parent, const IWindowHandle& owner, const IRectangle& initRect, const void* ctlData, const void* presParams, IWindow::SiblingOrder ordering = defaultOrdering ( ), unsigned long extendedStyle = 0 )
virtual IWindowHandle create( unsigned long id, const char* text, unsigned long style, IXmCreateFunction createFunction, const IWindowHandle& parent, const IWindowHandle& owner, const IRectangle& initRect, const void* callerArgList, unsigned int callerNumberArguments, IWindow::SiblingOrder ordering = defaultOrdering ( ), unsigned long extendedStyle = 0 )
virtual IWindowHandle create( unsigned long id, const char* text, const IBitFlag& style, const char* windowClass, const IWindow* parent, const IWindow* owner, const IRectangle& initRect, const void* ctlData, const void* presParams, IWindow::SiblingOrder ordering = defaultOrdering ( ) )
virtual IWindowHandle create( unsigned long id, const char* text, const IBitFlag& style, IXmCreateFunction createFunction, const IWindow* parent, const IWindow* owner, const IRectangle& initRect, IWindow::SiblingOrder ordering = defaultOrdering ( ) )
IWindow& defaultProcedure(IEvent& event)
bool deleteIsInProcess() const
bool dispatch(IEvent& event)
virtual unsigned long extendedStyle() const
bool isBoundToMessageQueue() const
virtual bool isDragStarting(IEvent& event)
bool isPrimaryWindow() const
bool isUserWindowWordReserved() const
IWindow()
IWindowNotifyHandler* notificationHandler() const
virtual IWindow& notifyObservers( const INotificationId& notification )
IObserverList& observerList( const IInterest* interest = 0 ) const
virtual bool passEventToOwner(IEvent& event)
virtual IWindow& prepareForUse( const IWindowHandle& windowHandle )
virtual IWindow& removeAllObservers()
static void removeFromWindowSet(IWindow* window)
IWindow& removeHandler(IHandler* oldHandler)
virtual IWindow& removeObserver(IObserver& observer)
virtual IWindow& removeObserver( IObserver& observer, const IInterest& interest )
IWindow& reserveUserWindowWord(bool reserve = true)
virtual IWindow& resetColor(unsigned long colorArea)
ISize savedMinimumSize() const
IWindow& saveMinimumSize(const ISize& size)
virtual IWindow& setBidiSettings( const IBidiSettings& bidiSettings, bool childInherit, bool refresh )
virtual IWindow& setColor( unsigned long colorArea, const IColor& color )
virtual IWindow& setDefaultEmphasisButton( const IWindowHandle& defaultEmphasisButton, bool enable )
virtual IWindow& setDefaultPushButton( const IWindowHandle& defaultPushButton )
virtual IWindow& setExtendedStyle( unsigned long extendedStyle )
IWindow& setNotificationHandler( IWindowNotifyHandler* notifyHandler )
virtual IWindow& setStyle(unsigned long style)
IWindow& setWindowData(long index, unsigned long dataValue)
IWindow& setWindowData( long index, unsigned short dataValue )
IWindow& startHandlingEventsFor( unsigned long identifier, IWindow* parent )
IWindow& startHandlingEventsFor( const IWindowHandle& windowHandle )
virtual unsigned long style() const
IWindow& unbindMessageQueue()
unsigned long windowULong(long index) const
unsigned short windowUShort(long index) const
virtual INotifier& addObserver( IObserver& observer, const IInterest& interest )
virtual INotifier& notifyObservers( const INotificationId& id ) = 0
virtual IObserverList& observerList( const IInterest* anInterest = 0 ) const = 0
virtual INotifier& removeAllObservers() = 0
virtual INotifier& removeObserver( IObserver& observer, const IInterest& interest )
virtual INotifier& removeObserver(IObserver& observer) = 0