The IBaseListBox class creates and manages list box control windows. List boxes always have vertical scroll bars. Optionally, they can have horizontal scroll bars. IBaseListBox contains general list box function except for population capability, such as adding, removing, or replacing list box items. The derived classes IListBox and ICollectionViewListBox supply these functions. IListBox contains the add, remove, and replace functions, while ICollectionViewListBox populates a list box from collection elements via the setItems member function. Typically, you use one of these classes derived from IBaseListBox.
You can enable a list box for the following types of item selection techniques:
A list box operates as if it is a 0-based array of items. The item index requested or returned is the 0-based index number of the location of the item in question.
Handlers derived from the following classes handle events for IBaseListBox:
Motif does not support owner-draw list boxes. This is because the underlying XmList widget treats the list box entries as an array of textual data. The OS/2 operating system Presentation Manager list box control, on the other hand, accesses each list box entry as a separate item.
The Open Class Library implements the IBaseListBox class using the XmList widget. Motif application developers should note that the IBaseListBox member functions use 0-based indexes, unlike the Motif XmList functions, which use 1-based indexes.
The library creates scrolled list box controls using the XmCreateScrolledList convenience function. This convenience function creates a composite control consisting of an XmScrolledWindow parent with an XmList child. The IBaseListBox control's handle is the widget ID of the XmList child, and any application utilizing native Motif functions should reflect this.
Two selection styles, extendedSelect and multipleSelect, are available for IBaseListBox controls. There is no explicit single-selection mode style. In the AIX environment, the default selection style is the Motif XmList default selection policy, XmBROWSE_SELECT. This default selection policy is not forced by the Open Class Library. Therefore, you can use an application resource file to specify your desired XmNselectionPolicy. By using an application resource file, you can specify an XmNselectionPolicy of XmSINGLE_SELECT.
When you add an IBaseListBox as a child window of a canvas and use ISetCanvas, ISplitCanvas, or IMultiCellCanvas, you must give it the style IBaseListBox::noAdjustPosition.
You can construct and destruct objects of this class.
![]() |
public:
virtual ~IBaseListBox()
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
IBaseListBox(unsigned long id, IWindow* parent)
You can create a list box control object using the parent window and a list box control ID.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
IBaseListBox(const IWindowHandle& handle)
You can create a list box control object using the handle of an existing list box control.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
IBaseListBox( unsigned long id, IWindow* parent, IWindow* owner, const IRectangle& initial = IRectangle ( ), const Style& style = defaultStyle ( ) )
You can create a list box control object using the parent window, owner window, optional size and location, and optional style arguments.
IInvalidParameter | The parent window is not valid. |
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to access the colors of the IBaseListBox.
![]() |
public:
virtual IColor backgroundColor() const
Returns the background color value of the list box area. If you have not set the color for the area, the default color is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
This member is overridden in this derived class for specific operating system behavior.
![]() |
public:
virtual IBaseListBox& setBackgroundColor( const IColor& color )
Sets the background color to the specified color.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IBaseListBox& setForegroundColor( const IColor& color )
Sets the foreground color to the specified color.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to determine the number of items in the list box.
![]() |
public:
virtual unsigned long count() const
Returns the number of items in the list box.
Note:
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual bool isEmpty() const
If the list box is empty, true is returned. Otherwise, false is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Event-handling implementation members provide the implementation of the event-handling mechanism.
![]() |
protected:
virtual bool passEventToOwner(IEvent& event)
Determines whether the event is be passed on to the owner.
Windows | OS/2 | AIX |
Yes | No | Yes |
Use these members to retrieve or change the text of an item in the list box.
![]() |
public:
virtual IString elementAt(const Cursor& cursor) const
Returns the string of the item at the cursor position.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IString itemText(unsigned long index) const
Returns the text of the specified item in the list box.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
Changes the text of the specified item in the list box.
public:
virtual IBaseListBox& setItemText( unsigned long index, const IResourceId& string )
Windows | OS/2 | AIX |
Yes | Yes | Yes |
public:
virtual IBaseListBox& setItemText( unsigned long index, const char* string )
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to set or retrieve a handle of a list box item. A handle is an optional data field that is associated with each list box item.
![]() |
public:
virtual unsigned long itemHandle(unsigned long index) const
Returns the handle of the specified list box item. If the item does not have a handle, 0 is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IBaseListBox& setItemHandle( unsigned long index, unsigned long handle )
Sets the handle of the specified list box item.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to set or retrieve the number of changes (add or remove items) that have occurred to the list box. These members help track the validity of IBaseListBox::Cursor objects.
![]() |
protected:
unsigned long changeCount() const
Retrieves the number of changes to the list box.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
protected:
void incrementChangeCount()
Increments the count of the number of list box changes. All IBaseListBox-derived classes add and remove functions should call this function because add and remove functions may cause an IBaseListBox::Cursor to become invalid.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to set or retrieve a list box item's height.
![]() |
public:
unsigned long itemHeight(unsigned long index = 0) const
Returns the height, in pixels, of a list box item. This is not the font size. It is the height of the cell within which an item is displayed.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
An index can be specified to retrieve the item height for a specific item when the listbox has the style LBS_OWNERDRAWVARIABLE.
![]() |
public:
virtual IBaseListBox& setItemHeight( unsigned long newHeight )
Sets the height, in pixels, of a list box item. This does not change the font size. It changes the height of the cell within which an item is displayed.
IAccessError | The operating system's request to set the height has failed. |
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to support canvases.
![]() |
public:
unsigned long minimumCharacters() const
Returns the maximum number of characters in an item of a minimum size list box.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
unsigned long minimumRows() const
Returns the number of visible rows of a minimum size list box.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IBaseListBox& setLayoutDistorted( unsigned long layoutAttributesOn, unsigned long layoutAttributesOff )
Causes a parent ISetCanvas or IMultiCellCanvas to update the size and position of the list box when it is assigned a new font.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IBaseListBox& setMinimumCharacters( unsigned long minimumCharacters )
Sets the maximum number of characters in an item of a minimum size list box. If you do not call this function, an item width of 25 characters is used.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IBaseListBox& setMinimumRows( unsigned long minimumRows )
Sets the number of rows in a minimum size list box. If you do not call this function, four rows are shown.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
protected:
virtual ISize calcMinimumSize() const
Returns the minimum size of the list box.
The size dimensions are as follows:
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to identify and enable notifications sent to observer objects.
![]() |
public:
virtual IBaseListBox& enableNotification( bool enable = true )
Enables the list box to send notifications to any observer objects.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static INotificationId const enterId
Notification identifier provided to observers when the user double-clicks on an item or presses Enter on an item with the cursor in a list box.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static INotificationId const extendedSelectChangedId
Notification identifier provided to observers when the extended select state of the list box changes.
This ID is only used by collection view list boxes.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static INotificationId const itemChangedId
Notification identifier provided to observers when a list box item changes due to a change in the underlying collection element.
This ID is only used by collection view list boxes.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static INotificationId const itemsId
Notification identifier provided to observers when the collection underlying the collection view list box is changed.
This ID is only used by collection view list boxes.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static INotificationId const selectId
Notification identifier provided to observers when an item is selected in a list box.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to scroll an item to the top of the list box or to return the item at the top of the list box.
![]() |
public:
virtual IBaseListBox& scrollToItem(unsigned long index)
Scrolls the specified item into the listbox view. The item is scrolled to the top of the listbox if above the listbox view. If the item is below the view of the listbox, then the item is scrolled to the bottom of the listbox.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IBaseListBox& setTop(unsigned long index)
Scrolls the specified item to the top of the list box.
IAccessError | There are no items in the list box. |
Windows | OS/2 | AIX |
Yes | Yes | Yes |
The system scrolls the list box contents so that either the specified item appears at the top of the list box or the maximum scroll range has been reached.
The system scrolls the list box contents so that either the specified item appears at the top of the list box or the maximum scroll range has been reached.
![]() |
public:
virtual unsigned long top() const
Returns the item number of the item currently at the top of the list box. If there are no items in the list box, an exception is thrown.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to search the list box portion of the combination box for a text string. The data structures aid that effort.
![]() |
public:
virtual unsigned long locateText( const char* searchString, bool caseSensitive = true, SearchType search = exactMatch, unsigned long index = first ) const
Returns the item number of the list box item matching the search string. You can specify the type of search by using the enumeration SearchType. If no match is found, this function returns notFound. If there is an error, an exception is thrown.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static const unsigned long first
Searches from the beginning of the string. This is a value for the index parameter of IBaseListBox::locateText.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static const unsigned long notFound
Indicates no match is found. IBaseListBox::locateText returns this value.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
Use these members to set or query the list box's selection state.
![]() |
public:
virtual IBaseListBox& deselect(unsigned long index)
Removes the selection state from an item.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IBaseListBox& deselectAll()
Removes the selection state from all items in the list box.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual bool isSelected(unsigned long index) const
Returns the selection state of an item. If the item is selected, true is returned.
Otherwise, false is returned.
Note:
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual unsigned long numberOfSelections() const
For single-selection list boxes, if no item is selected, 0 is returned. Otherwise, 1 is returned.
For multiple-selection or extended-selection list boxes,
the number of selected items in the list box is returned.
Note:
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IBaseListBox& select( unsigned long index, bool select = true )
Sets the selection state of an item based on the specified boolean value.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IBaseListBox& selectAll()
Sets the selection state for all items in the list box.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
An exception is thrown on OS/2 and Windows if the listbox is single-selection. On AIX, the last item in the listbox is selected.
![]() |
public:
virtual long selection() const
Returns the 0-based index of the selected item.
For single-selection list boxes, the index of the selected item is returned.
For multiple-selection or extended-selection list boxes, the index
of the first selected item is returned.
Note:
Windows | OS/2 | AIX |
Yes | Yes | Yes |
These style members provide a set of valid styles for the IBaseListBox class. Use these members to set and query list box styles. You can use these styles with the styles in the IWindow Styles class.
![]() |
public:
virtual unsigned long convertToGUIStyle( const IBitFlag& style, bool extendedOnly = false ) const
Converts a style object into a value appropriate for the presentation system. The default action is to return the base GUI styles for the platform. Extended styles, those defined by the application and the Open Class Library, are returned if you set extendedOnly to true.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static Style defaultStyle()
Returns the default style. The default style is classDefaultStyle unless you have changed the style using setDefaultStyle.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
virtual IBaseListBox& disableDrawItem()
Disables the style drawItem for the list box.
Windows | OS/2 | AIX |
Yes | Yes | Ignored |
The drawItem style is not supported on AIX.
![]() |
public:
virtual IBaseListBox& disableExtendedSelect()
Disables the style extendedSelect for the list box.
Windows | OS/2 | AIX |
Ignored | Yes | Yes |
An IBaseListBox::Style is used to control this behavior. This platform does not support dynamic change of behavior.
![]() |
public:
virtual IBaseListBox& disableMultipleSelect()
Disables the style multipleSelect for the list box.
Windows | OS/2 | AIX |
Ignored | Yes | Yes |
An IBaseListBox::Style is used to control this behavior. This platform does not support dynamic change of behavior.
![]() |
public:
virtual IBaseListBox& disableNoAdjustPosition()
Disables the style noAdjustPosition for the list box.
Windows | OS/2 | AIX |
Yes | Yes | Ignored |
The noAdjustPosition style is ignored on AIX.
![]() |
public:
virtual IBaseListBox& enableDrawItem(bool enable = true)
Enables or disables the style drawItem for the list box.
Windows | OS/2 | AIX |
Yes | Yes | Ignored |
The drawItem style is not supported on AIX.
![]() |
public:
virtual IBaseListBox& enableExtendedSelect( bool enable = true )
Enables or disables the style extendedSelect for the list box.
Windows | OS/2 | AIX |
Ignored | Yes | Yes |
An IBaseListBox::Style is used to control this behavior. This platform does not support dynamic change of behavior.
![]() |
public:
virtual IBaseListBox& enableMultipleSelect( bool enable = true )
Enables or disables the style multipleSelect for the list box.
Windows | OS/2 | AIX |
Ignored | Yes | Yes |
An IBaseListBox::Style is used to control this behavior. This platform does not support dynamic change of behavior.
![]() |
public:
virtual IBaseListBox& enableNoAdjustPosition( bool enable = true )
Enables or disables the style noAdjustPosition for the list box.
Windows | OS/2 | AIX |
Yes | Yes | Ignored |
The noAdjustPosition style is ignored on AIX.
![]() |
public:
bool isDrawItem() const
If the style drawItem is set, true is returned. Otherwise, false is returned.
Windows | OS/2 | AIX |
Yes | Yes | Ignored |
The drawItem style is not supported on AIX.
![]() |
public:
bool isExtendedSelect() const
If the style extendedSelect is set, true is returned. Otherwise, false is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
bool isHorizontalScroll() const
If the style horizontalScroll is set, true is returned. Otherwise, false is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
bool isMultipleSelect() const
If the style multipleSelect is set, true is returned. Otherwise, false is returned.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
bool isNoAdjustPosition() const
If the style noAdjustPosition is set, true is returned. Otherwise, false is returned.
Windows | OS/2 | AIX |
Yes | Yes | Ignored |
The noAdjustPosition style is ignored on AIX. This function always returns false.
![]() |
public:
static void setDefaultStyle(const Style& style)
Sets the default style for all subsequent list boxes.
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 |
![]() |
public:
static const Style border3D
Adds an etched 3D border to the control.
Windows | OS/2 | AIX |
Yes | Ignored | Ignored |
![]() |
public:
static const Style classDefaultStyle
Provides the original default style for this class, which is the following: IBaseListBox::horizontalScroll | IBaseListBox::noAdjustPosition | IBaseListBox::border3D | IWindow::visible.
If you do not specify either the extendedSelect or multipleSelect style, the list box is a single-selection list box by default.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static const Style drawItem
Draws list box items. It is typically used to display bitmaps.
Windows | OS/2 | AIX |
Yes | Yes | No |
![]() |
public:
static const Style extendedSelect
Extends selection to more than one object. This style is a type of selection optimized for the selection of a single object.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static const Style horizontalScroll
Allows horizontal scrolling of the list box.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static const Style multipleSelect
Specifies that the user can select any number of objects at a time in the list box or not select any.
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
public:
static const Style noAdjustPosition
Draws the list box control at the size specified. This can cause an item to be only partially shown.
Windows | OS/2 | AIX |
Yes | Yes | Ignored |
Use these members to display a window.
![]() |
public:
virtual IWindow& show(bool showList = true)
Makes the window visible.
Note:
Windows | OS/2 | AIX |
Yes | Yes | Yes |
![]() |
enum SearchType { prefix, substring, exactMatch }
Use these enumerators to specify the type of search to perform:
Windows | OS/2 | AIX |
Yes | Yes | Yes |
virtual ~IControl()
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 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
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 IWindowHandle handle() 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
static ISize parentSize(const IWindowHandle& windowHandle)
virtual ISize parentSize() const
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(RefreshType type = paintAll)
virtual IWindow& refresh( const IRectangle& invalidRectangle, bool immediate = false )
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()
virtual IEventResult sendEvent(const IEvent& event) const
virtual IEventResult sendEvent( unsigned long eventId, const IEventParameter1& parm1 = 0, const IEventParameter2& parm2 = 0 ) const
virtual IEventResult sendEvent( EventType eventType, const IEventParameter1& parm1 = 0, const IEventParameter2& parm2 = 0 ) const
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 const Style noStyle
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)
IColor color(unsigned long colorArea) const
IColor color( unsigned long colorArea, const IColor& defaultColor ) const
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, 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, const IBitFlag& style, IXmCreateFunction createFunction, const IWindow* parent, const IWindow* owner, const IRectangle& initRect, IWindow::SiblingOrder ordering = defaultOrdering ( ) )
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 ( ) )
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 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( const IWindowHandle& windowHandle )
IWindow& startHandlingEventsFor( unsigned long identifier, IWindow* parent )
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) = 0
virtual INotifier& removeObserver( IObserver& observer, const IInterest& interest )
IControl()