win32

package
v0.4.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 15, 2020 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Rendered for windows/amd64

Overview

Package win32 implements a partial shiny screen driver using the Win32 API. It provides window, lifecycle, key, and mouse management, but no drawing. That is left to windriver (using GDI) or gldriver (using DirectX via ANGLE).

Index

Constants

View Source 
const (
	// The window has a thin-line border.
	WS_BORDER = 0x00800000
	// The window has a title bar (includes the WS_BORDER style).
	WS_CAPTION = 0x00C00000
	// The window is a child window. A window with this style cannot have a menu bar.
	// This style cannot be used with the WS_POPUP style.
	WS_CHILD = 0x40000000
	// Same as the WS_CHILD style.
	WS_CHILDWINDOW = WS_CHILD
	// Excludes the area occupied by child windows when drawing occurs within the parent window.
	// This style is used when creating the parent window.
	WS_CLIPCHILDREN = 0x02000000
	// Clips child windows relative to each other; that is, when a particular child window receives
	// a WM_PAINT message, the WS_CLIPSIBLINGS style clips all other overlapping child windows out
	// of the region of the child window to be updated. If WS_CLIPSIBLINGS is not specified and
	// child windows overlap, it is possible, when drawing within the client area of a child window,
	// to draw within the client area of a neighboring child window.
	WS_CLIPSIBLINGS = 0x04000000
	// The window is initially disabled. A disabled window cannot receive input from the user.
	// To change this after a window has been created, use the EnableWindow function.
	WS_DISABLED = 0x08000000
	// The window has a border of a style typically used with dialog boxes.
	// A window with this style cannot have a title bar.
	WS_DLGFRAME = 0x00400000
	// The window is the first control of a group of controls.
	// The group consists of this first control and all controls defined after it,
	// up to the next control with the WS_GROUP style. The first control in each group usually has
	// the WS_TABSTOP style so that the user can move from group to group. The user can subsequently
	// change the keyboard focus from one control in the group to the next control in the group by
	// using the direction keys.
	//
	// You can turn this style on and off to change dialog box navigation.
	// To change this style after a window has been created, use the SetWindowLong function.
	WS_GROUP = 0x00020000
	// The window has a horizontal scroll bar.
	WS_HSCROLL = 0x00100000
	// The window is initially minimized. Same as the WS_MINIMIZE style.
	WS_ICONIC = 0x20000000
	// The window is initially maximized.
	WS_MAXIMIZE = 0x01000000
	// The window is initially minimized. Same as the WS_ICONIC style.
	WS_MINIMIZE = WS_ICONIC
	// The window is an overlapped window.
	// An overlapped window has a title bar and a border. Same as the WS_TILED style.
	WS_OVERLAPPED = 0x00000000
	// The window has a minimize button. Cannot be combined with the WS_EX_CONTEXTHELP style.
	// The WS_SYSMENU style must also be specified.
	WS_MINIMIZEBOX = 0x00020000
	// The window has a maximize button. Cannot be combined with the WS_EX_CONTEXTHELP style.
	// The WS_SYSMENU style must also be specified.
	WS_MAXIMIZEBOX = 0x00010000
	// The window is an overlapped window. Same as the WS_TILEDWINDOW style.
	WS_OVERLAPPEDWINDOW = WS_OVERLAPPED | WS_CAPTION | WS_SYSMENU | WS_THICKFRAME | WS_MINIMIZEBOX | WS_MAXIMIZEBOX
	// The windows is a pop-up window. This style cannot be used with the WS_CHILD style.
	WS_POPUP = 0x80000000
	// The window is a pop-up window. The WS_CAPTION and WS_POPUPWINDOW styles must be
	// combined to make the window menu visible.
	WS_POPUPWINDOW = WS_POPUP | WS_BORDER | WS_SYSMENU
	// The window has a sizing border. Same as the WS_THICKFRAME style.
	WS_SIZEBOX = 0x00040000
	// The window has a window menu on its title bar. The WS_CAPTION style must also be specified.
	WS_SYSMENU = 0x00080000
	// The window is a control that can receive the keyboard focus when the user presses the TAB key.
	// Pressing the TAB key changes the keyboard focus to the next control with the WS_TABSTOP style.
	// You can turn this style on and off to change dialog box navigation.
	// To change this style after a window has been created, use the SetWindowLong function.
	// For user-created windows and modeless dialogs to work with tab stops, alter the message loop
	// to call the IsDialogMessage function.
	WS_TABSTOP = 0x00010000
	// The window has a sizing border. Same as the WS_SIZEBOX style.
	WS_THICKFRAME = WS_SIZEBOX
	// The window is an overlapped window. An overlapped window has a title bar and a border.
	// Same as the WS_OVERLAPPED style.
	WS_TILED = WS_OVERLAPPED
	// The window is an overlapped window. Same as the WS_OVERLAPPEDWINDOW style.
	WS_TILEDWINDOW = WS_OVERLAPPEDWINDOW
	// The window is initially visible.
	// This style can be turned on and off by using the ShowWindow or SetWindowPos function.
	WS_VISIBLE = 0x10000000
	// The window has a vertical scroll bar.
	WS_VSCROLL = 0x00200000
)

Docs copied from https://msdn.microsoft.com/en-us/library/windows/desktop/ms632600(v=vs.85).aspx These settings have a minimum requirement of windows 2000.

View Source 
const (
	// The window accepts drag-drop files.
	WS_EX_ACCEPTFILES = 0x00000010
	// Forces a top-level window onto the taskbar when the window is visible.
	WS_EX_APPWINDOW = 0x00040000
	// The window has a border with a sunken edge.
	WS_EX_CLIENTEDGE = 0x00000200
	// Paints all descendants of a window in bottom-to-top painting order using double-buffering.
	// For more information, see Remarks. This cannot be used if the window has a class style of either CS_OWNDC or CS_CLASSDC.
	// Windows 2000:  This style is not supported.
	WS_EX_COMPOSITED = 0x02000000
	// The title bar of the window includes a question mark. When the user clicks the question mark,
	// the cursor changes to a question mark with a pointer. If the user then clicks a child window,
	// the child receives a WM_HELP message. The child window should pass the message to the parent window procedure,
	// which should call the WinHelp function using the HELP_WM_HELP command. The Help application displays
	// a pop-up window that typically contains help for the child window.
	// WS_EX_CONTEXTHELP cannot be used with the WS_MAXIMIZEBOX or WS_MINIMIZEBOX styles.
	WS_EX_CONTEXTHELP = 0x00000400
	// The window itself contains child windows that should take part in dialog box navigation.
	// If this style is specified, the dialog manager recurses into children of this window when
	// performing navigation operations such as handling the TAB key, an arrow key, or a keyboard mnemonic.
	WS_EX_CONTROLPARENT = 0x00010000
	// The window has a double border; the window can, optionally, be created with a title bar
	// by specifying the WS_CAPTION style in the dwStyle parameter.
	WS_EX_DLGMODALFRAME = 0x00000001
	// The window is a layered window. This style cannot be used if the window has a
	// class style of either CS_OWNDC or CS_CLASSDC.
	// Windows 8:  The WS_EX_LAYERED style is supported for top-level windows and
	// child windows. Previous Windows versions support WS_EX_LAYERED only for top-level windows.
	WS_EX_LAYERED = 0x00080000
	// If the shell language is Hebrew, Arabic, or another language that supports reading
	// order alignment, the horizontal origin of the window is on the right edge.
	// Increasing horizontal values advance to the left.
	WS_EX_LAYOUTRTL = 0x00400000
	// The window has generic left-aligned properties. This is the default.
	WS_EX_LEFT = 0x00000000
	// If the shell language is Hebrew, Arabic, or another language that supports reading order
	// alignment, the vertical scroll bar (if present) is to the left of the client area.
	// For other languages, the style is ignored.
	WS_EX_LEFTSCROLLBAR = 0x00004000
	// The window text is displayed using left-to-right reading-order properties. This is the default.
	WS_EX_LTRREADING = 0x00000000
	// The window is a MDI child window.
	WS_EX_MDICHILD = 0x00000040
	// A top-level window created with this style does not become the foreground window when the
	// user clicks it. The system does not bring this window to the foreground when the user
	// minimizes or closes the foreground window.
	// To activate the window, use the SetActiveWindow or SetForegroundWindow function.
	// The window does not appear on the taskbar by default. To force the window to appear
	// on the taskbar, use the WS_EX_APPWINDOW style.
	WS_EX_NOACTIVATE = 0x08000000
	// The window does not pass its window layout to its child windows.
	WS_EX_NOINHERITLAYOUT = 0x00100000
	// The child window created with this style does not send the WM_PARENTNOTIFY message
	// to its parent window when it is created or destroyed.
	WS_EX_NOPARENTNOTIFY = 0x00000004
	// The window does not render to a redirection surface. This is for windows that do not
	// have visible content or that use mechanisms other than surfaces to provide their visual.
	WS_EX_NOREDIRECTIONBITMAP = 0x00200000
	// The window is an overlapped window.
	WS_EX_OVERLAPPEDWINDOW = (WS_EX_WINDOWEDGE | WS_EX_CLIENTEDGE)
	// The window is palette window, which is a modeless dialog box that presents an array of commands.
	WS_EX_PALETTEWINDOW = (WS_EX_WINDOWEDGE | WS_EX_TOOLWINDOW | WS_EX_TOPMOST)
	// The window has generic "right-aligned" properties. This depends on the window class.
	// This style has an effect only if the shell language is Hebrew, Arabic, or another language
	// that supports reading-order alignment; otherwise, the style is ignored.
	// Using the WS_EX_RIGHT style for static or edit controls has the same effect as using the SS_RIGHT
	// or ES_RIGHT style, respectively. Using this style with button controls has the same effect as
	// using BS_RIGHT and BS_RIGHTBUTTON styles.
	WS_EX_RIGHT = 0x00001000
	//The vertical scroll bar (if present) is to the right of the client area. This is the default.
	WS_EX_RIGHTSCROLLBAR = 0x00000000
	// If the shell language is Hebrew, Arabic, or another language that supports reading-order alignment,
	// the window text is displayed using right-to-left reading-order properties.
	// For other languages, the style is ignored.
	WS_EX_RTLREADING = 0x00002000
	// The window has a three-dimensional border style intended to be used for items that do not accept user input.
	WS_EX_STATICEDGE = 0x00020000
	// The window is intended to be used as a floating toolbar.
	// A tool window has a title bar that is shorter than a normal title bar, and the window title is drawn
	// using a smaller font. A tool window does not appear in the taskbar or in the dialog that
	// appears when the user presses ALT+TAB. If a tool window has a system menu, its icon is not displayed
	// on the title bar. However, you can display the system menu by right-clicking or by typing ALT+SPACE.
	WS_EX_TOOLWINDOW = 0x00000080
	// The window should be placed above all non-topmost windows and should stay above them,
	// even when the window is deactivated. To add or remove this style, use the SetWindowPos function.
	WS_EX_TOPMOST = 0x00000008
	// The window should not be painted until siblings beneath the window (that were created by the same thread)
	// have been painted. The window appears transparent because the bits of underlying sibling windows have
	// already been painted.
	// To achieve transparency without these restrictions, use the SetWindowRgn function.
	WS_EX_TRANSPARENT = 0x00000020
	// The window has a border with a raised edge.
	WS_EX_WINDOWEDGE = 0x00000100
)

Variables

View Source 
var (
	MouseEvent     func(hwnd w32.HWND, e mouse.Event)
	PaintEvent     func(hwnd w32.HWND, e paint.Event)
	SizeEvent      func(hwnd w32.HWND, e size.Event)
	KeyEvent       func(hwnd w32.HWND, e key.Event)
	LifecycleEvent func(hwnd w32.HWND, e lifecycle.Stage)
)

Functions

func AddScreenMsg 

func AddScreenMsg(fn func(hwnd w32.HWND, uMsg uint32, wParam, lParam uintptr)) uint32

func AddWindowMsg 

func AddWindowMsg(fn func(hwnd w32.HWND, uMsg uint32, wParam, lParam uintptr)) uint32

func GetDC 

func GetDC(hwnd w32.HWND) (dc syscall.Handle, err error)

func Main 

func Main(f func()) (retErr error)

func MoveWindow 

func MoveWindow(hwnd w32.HWND, x int32, y int32, w int32, h int32, repaint bool) (err error)

func NewWindow 

func NewWindow(opts screen.WindowGenerator) (w32.HWND, error)

func Release 

func Release(hwnd w32.HWND)

func ReleaseDC 

func ReleaseDC(hwnd w32.HWND, dc syscall.Handle) (err error)

func ResizeClientRect 

func ResizeClientRect(hwnd w32.HWND, opts screen.WindowGenerator) error

ResizeClientRect makes hwnd client rectangle opts.Width by opts.Height in size.

func SendScreenMessage 

func SendScreenMessage(uMsg uint32, wParam uintptr, lParam uintptr) (lResult uintptr)

func Show 

func Show(hwnd w32.HWND)

Show shows a newly created window. It sends the appropriate lifecycle events, makes the window appear on the screen, and sends an initial size event.

This is a separate step from NewWindow to give the driver a chance to setup its internal state for a window before events start being delivered.

func WindowsStyle 

func WindowsStyle(gen screen.WindowGenerator) (uint32, uint32)

WindowsStyle converts a screen.BorderStyle into a style and exStyle for a Windows window

Types

This section is empty.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.