SFBWindowMgr0

Wrapper Class for the IWindowMgr0 interface.

#include <SFBWindowMgr0.h.hpp>

class SFBWindowMgr0 : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBWindowMgr0)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
X	X	X	O

Reference

BREW API IWindowMgr0

Member

Public Functions
`SFCError`	ActivateWindow( `SFBQuerySmpConstRef` widget ) Activate a window by bringing it to the top of the z-order and setting the current focus to it.
`SFCError`	CloseWindow( `SFBQuerySmpConstRef` widget ) Close a window by removing it from the window manager.
`SFCError`	CreateWindow( `SFBQuerySmpConstRef` widget , `UInt32` flags ) Creates a window from an application-owned widget and insert it into the window manager.
`SFCError`	GetExtent( `AEEExtent *` extent ) Get the canvas size of the window manager.
static `SFBWindowMgr0Smp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBWindowMgr0 instance.
static `SFBWindowMgr0Smp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBWindowMgr0 instance.
`SFCError`	SetWindowProp( `SFBQuerySmpConstRef` widget , `AEECLSID` id , `VoidConstPtr` data , `SInt32` size ) Pass additional, implementation-specific information to a window.
`SFCError`	SetWindowProp( `SFBQuerySmpConstRef` widget , `AEECLSID` id , `SFXBufferConstRef` data ) Pass additional, implementation-specific information to a window.
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBWindowMgr0::ActivateWindow

Activate a window by bringing it to the top of the z-order and setting the current focus to it.

[ public ]
SFCError ActivateWindow(
    SFBQuerySmpConstRef widget   // widget that identifies the window to activate 
);

Return value

Error code.

Reference

BREW API IWindowMgr0_ActivateWindow

SFBWindowMgr0::CloseWindow

Close a window by removing it from the window manager.

[ public ]
SFCError CloseWindow(
    SFBQuerySmpConstRef widget   // widget that indentifies the window to close 
);

Return value

Error code.

Reference

BREW API IWindowMgr0_CloseWindow

SFBWindowMgr0::CreateWindow

Creates a window from an application-owned widget and insert it into the window manager.

[ public ]
SFCError CreateWindow(
    SFBQuerySmpConstRef widget   // widget to be used as a window 
    UInt32 flags                 // window creation flags 
);

Argument

widget

widget to be used as a window

flags

window creation flags

WMCWF_STYLE_MAIN window is a main window
WMCWF_STYLE_POPUP window is a popup window
WMCWF_STYLE_SOFTKEY window is a softkey window
WMCWF_NOACTIVATE do not activate window on creation
WMCWF_FULLSCREEN display window full screen

Return value

Error code.

Description

The WMCWF_STYLE_xxx values specify different window types or 'styles' that may behave differently within the window manager. For example, a window created with the WMCWF_STYLE_SOFTKEY style would be sized, positioned and treated differently than a WMCWF_STYLE_MAIN window.

WMCWF_STYLE_xxx are 4-bit values, and hence are mutually exclusive. Do not combine two or more of these values together by ORing them; unexpected results may occur.

Reference

BREW API IWindowMgr0_CreateWindow

SFBWindowMgr0::GetExtent

Get the canvas size of the window manager.

[ public ]
SFCError GetExtent(
    AEEExtent * extent   // Pointer to AEEExtent structure to receive dimensions 
);

Return value

Error code.

Description

This function is provided so that applications may determine how to size windows (such as popups) to reasonable dimensions.

Reference

BREW API IWindowMgr0_GetExtent

SFBWindowMgr0::NewInstance

Create a new SFBWindowMgr0 instance.

[ public, static ]
SFBWindowMgr0Smp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBWindowMgr0Smp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBWindowMgr0::SetWindowProp

Pass additional, implementation-specific information to a window.

[ public ]
SFCError SetWindowProp(
    SFBQuerySmpConstRef widget   // widget that identifies the window 
    AEECLSID id                  // unique ID used as a key for the window property to set 
    VoidConstPtr data            // pointer to start of data buffer 
    SInt32 size                  // size of data buffer in bytes 
);

[ public ]
SFCError SetWindowProp(
    SFBQuerySmpConstRef widget   // widget that identifies the window 
    AEECLSID id                  // unique ID used as a key for the window property to set 
    SFXBufferConstRef data       // pointer to start of data buffer 
);

Return value

Error code.

Description

The window informaion is identified by a unique key (a class ID).

Reference

BREW API IWindowMgr0_SetWindowProp