Documentation for Win32lib v0.60.6
Table of Contents

Constants

They are often required to send information to the routines in the library.


  • const advapi32   Windows Library: Advanced API
  • const CCexflags    Used by function classDefaults() to indicate Extended Style Flags
  • const CCflags    Used by function classDefaults() to indicate Style Flags
  • const CCwinstyle    Used by function classDefaults() to set the style flags when
  • const comctl32   Windows Library: Common Controls
  • const comdlg32   Windows Library: Common Dialogs
  • const Default    Indicates the use of the Windows default position values when creating Controls.
  • const gdi32   Windows Library: Graphic Device Interface (drawing, text, etc)
  • const kernel32   Windows Library: Memory and Basic Windows Core
  • const kLVColTypes    Used by setLVAttr
  • const kLVSortRtn    Used by setLVAttr
  • const kLVSortSeq    Used by setLVAttr
  • const kMainMsg    Used by the notify handlers. See setNotifyHandler
  • const kSubclassedMsg    Used by the notify handlers. See setNotifyHandler
  • const ole32   Windows Library: Graphic Device Interface (drawing, text, etc)
  • const riched32   Windows Library: Rich Edit Control
  • const shell32   Windows Library: Shell Extensions
  • const user32   Windows Library: User Interface
  • const w32AltEdge   Specifies the alternate edge required when creating or moving a control.
  • const w32Edge   Specifies the extreme edge required when creating or moving a control.
  • const w32False   The value for a boolean FALSE.
  • const w32KH_SetFocus   Used as a return value by w32HKeyDown handlers to indicate that the focus needs to be changed.
  • const w32LV_EndSorting    Used by ListView controls that have a custom sorting routine.
  • const w32LV_StartSorting    Used by ListView controls that have a custom sorting routine.
  • const w32MsgNum   This is the recommended starting point for user defined error codes.
  • const w32PB_BITMAP    Used when creating a PictureButton and ToggleButton.
  • const w32PB_ICON    Used when creating a PictureButton and ToggleButton.
  • const w32True   The value for a boolean True
  • const Win32LibVersion   Contains the current version of win32lib library.
  • const winmm32   Windows Library: Multi-Media

    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    advapi32

    Windows Library: Advanced API

    Category: Constants

    See Also: CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    CCexflags

    Used by function classDefaults() to indicate Extended Style Flags

    Category: Constants

    See Also: advapi32, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    CCflags

    Used by function classDefaults() to indicate Style Flags

    Category: Constants

    See Also: advapi32, CCexflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    CCwinstyle

    Used by function classDefaults() to set the style flags when

    Category: Constants

    registering a new window class.

    See Also: advapi32, CCexflags, CCflags, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    comctl32

    Windows Library: Common Controls

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    comdlg32

    Windows Library: Common Dialogs

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    Default

    Indicates the use of the Windows default position values when creating Controls.

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    gdi32

    Windows Library: Graphic Device Interface (drawing, text, etc)

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    kernel32

    Windows Library: Memory and Basic Windows Core

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    kLVColTypes

    Used by setLVAttr

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    kLVSortRtn

    Used by setLVAttr

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    kLVSortSeq

    Used by setLVAttr

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    kMainMsg

    Used by the notify handlers. See setNotifyHandler

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    kSubclassedMsg

    Used by the notify handlers. See setNotifyHandler

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    ole32

    Windows Library: Graphic Device Interface (drawing, text, etc)

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    riched32

    Windows Library: Rich Edit Control

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    shell32

    Windows Library: Shell Extensions

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    user32

    Windows Library: User Interface

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    w32AltEdge

    Specifies the alternate edge required when creating or moving a control.

    Category: Constants

    This only makes sense when used in specifing the X,Y positions. The constant is a reference to the 'far' edge. This is the Righthand side for the X co-ordinate, and the Bottom edge for the Y co-ordinate. It is usually used in conjection with negative offsets. example

              -- Create a edit area aligned with the righhand edge.
              fldWidth = 100
               myEdit = create(MleText, "", myWin,
                         -- left edge is 'fldWidth' pixels from the RHS side of the window.
                         {w32AltEdge, -fldWidth}
                         20,             -- top edge is 20 pixels down
                         fldWidth,       -- width of the field
                         200,            -- height of 200 pixels
                         0)
    

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    w32Edge

    Specifies the extreme edge required when creating or moving a control.

    Category: Constants

    example

              -- Create a edit area
               myEdit = create(MleText, "", myWin,
                         0.50,           -- left edge is 50% of window's width
                         20,             -- top edge is 20 pixels down
                         w32Edge,        -- right edge is window's right edge
                         {w32Edge, -25},  -- bottom edge is window's bottom
                                         --   edge less 25 pixels.
                         0)
    

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    w32False

    The value for a boolean FALSE.

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    w32KH_SetFocus

    Used as a return value by w32HKeyDown handlers to indicate that the focus needs to be changed.

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    w32LV_EndSorting

    Used by ListView controls that have a custom sorting routine.

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    w32LV_StartSorting

    Used by ListView controls that have a custom sorting routine.

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    w32MsgNum

    This is the recommended starting point for user defined error codes.

    Category: Constants

    There are no win32lib error codes from this number on.
    Example:

       constant BadResponse  = w32MsgNum + 0,
                FileNotFound = w32MsgNum + 1,
                ReadOnlyFile = w32MsgNum + 2
       . . .
        abortErr( {The requested file could not be located.", FileNotFound})
    

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    w32PB_BITMAP

    Used when creating a PictureButton and ToggleButton.

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_ICON, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    w32PB_ICON

    Used when creating a PictureButton and ToggleButton.

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32True, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    w32True

    The value for a boolean True

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, Win32LibVersion, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    Win32LibVersion

    Contains the current version of win32lib library.

    Category: Constants

    This is a sequence containing three elements.

  • Major version number
  • Minor version number
  • Patch or Revision number
  • Date of the version in DD-mmm-YYYY format

    Example

           setText(SB, sprintf("Win32Lib version %d.%d Patch#%d, %s",
                                Win32LibVersion))
    

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, winmm32


    Documentation for Win32lib v0.60.6
    Table of Contents

    [const]
    winmm32

    Windows Library: Multi-Media

    Category: Constants

    See Also: advapi32, CCexflags, CCflags, CCwinstyle, comctl32, comdlg32, Default, gdi32, kernel32, kLVColTypes, kLVSortRtn, kLVSortSeq, kMainMsg, kSubclassedMsg, ole32, riched32, shell32, user32, w32AltEdge, w32Edge, w32False, w32KH_SetFocus, w32LV_EndSorting, w32LV_StartSorting, w32MsgNum, w32PB_BITMAP, w32PB_ICON, w32True, Win32LibVersion