TWindow

Core Class Root Class source/classes/window.prg

TWindow is the root class of the entire FiveWin class hierarchy. Every visible element in a FiveWin application — dialogs, controls, MDI frames, MDI children — ultimately inherits from TWindow. It wraps a Win32 HWND and provides the foundational API for window creation, event handling, painting, coordinate management, drag-and-drop, tooltips, and more.

Inheritance Hierarchy

TWindow sits at the top of the hierarchy. All major FiveWin classes derive from it directly or indirectly:

Key DATA Members

Event Code Blocks

TWindow exposes a rich set of code blocks that fire on Win32 events. Assign a block to hook into any event:

Key Methods

New() — Constructor

METHOD New( nTop, nLeft, nBottom, nRight, cTitle, nStyle, oMenu,
      oBrush, oIcon, oWnd, lVScroll, lHScroll, nClrFore, nClrBack,
      oCursor, cBorder, lSysMenu, lCaption, lMin, lMax, lPixel,
      nExStyle, cVarName, nHelpId, lUnicode, nWidth, nHeight )

Creates a new TWindow instance but does not show it. The window handle hWnd is not yet created; that happens during Activate().

Activate()

METHOD Activate( cShow, bLClicked, bRClicked, bMoved, bResized,
      bPainted, bKeyDown, bInit, bUp, bDown, bPgUp, bPgDown,
      bLeft, bRight, bPgLeft, bPgRight, bValid, bDropFiles,
      bLButtonUp, lCentered, oMonitor )

Creates the Win32 window, shows it, and enters the message loop. The cShow parameter can be "MAXIMIZED", "ICONIZED", or "NORMAL" (default). The method does not return until the window is closed.

End()

Sends WM_CLOSE to the window. If bValid is set, it is evaluated first; closing is cancelled when bValid returns .F..

Other Essential Methods

Commands: DEFINE WINDOW / ACTIVATE WINDOW

FiveWin provides preprocessor commands that translate to TWindow method calls. This is the recommended way to create windows:

DEFINE WINDOW

DEFINE WINDOW oWnd ;
   [ FROM nTop, nLeft TO nBottom, nRight ] ;
   [ TITLE cTitle ] ;
   [ STYLE nStyle ] ;
   [ MENU oMenu ] ;
   [ BRUSH oBrush ] ;
   [ ICON oIcon ] ;
   [ OF oParent ] ;
   [ VSCROLL ] [ HSCROLL ] ;
   [ COLOR nClrText, nClrBack ] ;
   [ CURSOR oCursor ] ;
   [ BORDER cBorder ] ;   // "NONE", "SINGLE"
   [ NOSYSMENU ] ;
   [ NOCAPTION ] ;
   [ NOMINIMIZE ] ;
   [ NOMAXIMIZE ] ;
   [ PIXEL ] ;
   [ HELPID nHelpId ] ;
   [ UNICODE ]

ACTIVATE WINDOW

ACTIVATE WINDOW oWnd ;
   [ MAXIMIZED | ICONIZED | NORMAL ] ;
   [ ON LEFT CLICK bLClicked ] ;
   [ ON RIGHT CLICK bRClicked ] ;
   [ ON MOVE bMoved ] ;
   [ ON RESIZE bResized ] ;
   [ ON PAINT bPainted ] ;
   [ ON KEYDOWN bKeyDown ] ;
   [ ON INIT bInit ] ;
   [ ON UP bUp ] [ ON DOWN bDown ] ;
   [ ON PAGEUP bPgUp ] [ ON PAGEDOWN bPgDown ] ;
   [ ON LEFT bLeft ] [ ON RIGHT bRight ] ;
   [ VALID bValid ] ;
   [ ON DROP bDropFiles ] ;
   [ CENTERED ]

Window Lifecycle

The key insight is that Activate() is a blocking call that runs the Windows message loop. Code placed after ACTIVATE WINDOW only runs after the window has been closed.

Example: Main Window with Menu, Toolbar, and StatusBar

#include "FiveWin.ch"

function Main()

   local oWnd, oBar, oFont

   DEFINE FONT oFont NAME "Segoe UI" SIZE 0, -14

   DEFINE WINDOW oWnd TITLE "My Application" ;
      COLOR CLR_BLACK, CLR_WHITE

   DEFINE BUTTONBAR oBar OF oWnd SIZE 56, 56 2007

   DEFINE BUTTON OF oBar RESOURCE "NEW"  ;
      ACTION MsgInfo( "New document" )    ;
      TOOLTIP "New"

   DEFINE BUTTON OF oBar RESOURCE "OPEN" ;
      ACTION MsgInfo( "Open file" )       ;
      TOOLTIP "Open"

   DEFINE BUTTON OF oBar RESOURCE "SAVE" ;
      ACTION MsgInfo( "Save file" )       ;
      TOOLTIP "Save"

   SET MESSAGE OF oWnd TO "Ready" ;
      CENTERED CLOCK DATE KEYBOARD

   MENU oMenu
      MENUITEM "&File"
      MENU
         MENUITEM "&New"    ACTION MsgInfo( "New" )    MESSAGE "Create new document"
         MENUITEM "&Open"   ACTION MsgInfo( "Open" )   MESSAGE "Open existing file"
         MENUITEM "&Save"   ACTION MsgInfo( "Save" )   MESSAGE "Save current file"
         SEPARATOR
         MENUITEM "E&xit"   ACTION oWnd:End()          MESSAGE "Exit application"
      ENDMENU
      MENUITEM "&Help"
      MENU
         MENUITEM "&About"  ACTION MsgAbout()
      ENDMENU
   ENDMENU

   oWnd:SetMenu( oMenu )
   oWnd:SetFont( oFont )

   ACTIVATE WINDOW oWnd MAXIMIZED ;
      ON INIT ( oWnd:SetFocus() ) ;
      VALID ( MsgYesNo( "Exit application?" ) )

   oFont:End()

return nil

Example: MDI Application

MDI (Multiple Document Interface) allows a main frame window to host multiple child windows. FiveWin provides TMDIFrame and TMDIChild, both derived from TWindow:

#include "FiveWin.ch"

static oWnd

function Main()

   local oBar

   DEFINE WINDOW oWnd TITLE "MDI Application" MDI ;
      COLOR CLR_BLACK, GetSysColor( COLOR_APPWORKSPACE )

   DEFINE BUTTONBAR oBar OF oWnd SIZE 56, 56 2007

   DEFINE BUTTON OF oBar RESOURCE "NEW" ;
      ACTION NewChild() TOOLTIP "New Document"

   SET MESSAGE OF oWnd TO "Ready" CENTERED CLOCK DATE

   MENU oMenu
      MENUITEM "&File"
      MENU
         MENUITEM "&New Child"  ACTION NewChild()
         SEPARATOR
         MENUITEM "E&xit"       ACTION oWnd:End()
      ENDMENU
      MENUITEM "&Window"
      MENU
         MENUITEM "&Tile"       ACTION oWnd:Tile()
         MENUITEM "Ca&scade"    ACTION oWnd:Cascade()
         MENUITEM "Arrange &Icons" ACTION oWnd:IconArrange()
         SEPARATOR
         MENUITEM "Close &All"  ACTION oWnd:CloseAll()
      ENDMENU
   ENDMENU

   oWnd:SetMenu( oMenu )

   ACTIVATE WINDOW oWnd MAXIMIZED

return nil

//--------------------------------------------------------------------//

static function NewChild()

   local oChild
   static nCount := 0

   nCount++

   DEFINE WINDOW oChild TITLE "Document " + LTrim( Str( nCount ) ) ;
      MDICHILD OF oWnd

   ACTIVATE WINDOW oChild

return nil

Usage Tips

• Double-buffered painting — Wrap custom painting inside DispBegin() / DispEnd() to eliminate flicker.
• Window position persistence — Save nTop, nLeft, nBottom, nRight to an INI file in bValid and restore them in New().
• Gradient backgrounds — Set aGradColors to an array of color pairs: oWnd:SetGradient( { { 0.5, nRGB(40,40,50), nRGB(20,20,30) }, { 0.5, nRGB(20,20,30), nRGB(10,10,15) } } ).
• Unicode — Pass UNICODE in the DEFINE WINDOW command, or call FW_SetUnicode( .T. ) globally, to use wide-character Win32 APIs.
• aControls — Iterate child controls via AEval( oWnd:aControls, {|o| o:Refresh() } ) or the newer ForEachControl() method.
• Monitor-aware — Pass oMonitor to Activate() to open the window on a specific monitor in multi-display setups.

Docking Bars

TWindow provides dedicated docking slots for arranging controls around the window edges. Assign a control to the appropriate slot and call the corresponding adjustment method to create resizable layouts:

The docking system follows a standard layout algorithm: the message bar occupies the bottom, the toolbar the top, then left/right docks claim their widths, and the client control fills whatever space remains. Assign a control to the slot and call AdjClient() (or the specific Adj*() method) to position it. In the ON RESIZE handler, call the methods again to adapt to size changes.

Veja Também

• TDialog — Modal and modeless dialog boxes (inherits from TWindow)
• TControl — Base class for all UI controls (inherits from TWindow)
• TMenu — Menu system