Description


Include file: xbubble.h

Parent class: XUserWindow

Overview

XBubbleHelp is a window which can display short help-messages, it looks like the bubbles on a mac.

To use XBubbleHelp derive a class of it and override XBubbleHelp::SetMsgText(). See XBubbleHelp::AddWindow() and XBubbleHelp::XBubbleHelp() for details how to select windows to show help-messages for.

For applications which use XBubblehelp it is nessacary that two bitmaps are linked to the resources of the application (in the *.RES file): BUBBLE1.BMP which must have the resource-id 10000 and BUBBLE2.BMP with the resource-id 10001. You can find these bitmaps in the directory ..OOL\RESOURCE

The destructor is not called automaticaly when the window is hidden.

XBubbleHelp does not work with menus!

Functions

XBubbleHelp

Parameters

XResource * A resource which points to a resource-library which contains the needed bitmaps
XWindow * The owner-window.
BOOL handleAll TRUE=all clients are handled automaticaly, you dont need to call AddWindow
FALSE=no clients are handled, you must add clients to handle with AddWindow()

Remarks

Construct a bubblehelp-window

Enable

Parameters

BOOL enable TRUE=enable, FALSE=disable (default is TRUE)

Remarks

Enable/disable XBubbleHelp

SetMsgText

Parameters

ULONG id the window-id from the window to display a helptext for

Return-Value

BOOL TRUE=show the bubble, FALSE=dont display the bubble

Remarks

Override this function to select the text to display with SetText()

SetText

Parameters

char * theText

Remarks

Set the text to display


This document was generated by Jens von Pilgrim's Autodoc