Platform

Description

Interface for interacting with the platform (OS).

Classes

struct  OSPointerButtonStates
 Describes pointer (mouse, touch) states as reported by the OS. More...
 
class  OSDropTarget
 Drop targets allow you to register a certain portion of a window as a drop target that accepts certain drop types from the OS (platform) specific drag and drop system. More...
 
struct  NonClientResizeArea
 Represents a specific non client area used for window resizing. More...
 
struct  WindowNonClientAreaData
 Contains a list of window move and resize non client areas. More...
 
struct  Platform::Pimpl
 
class  Platform
 Provides access to various operating system functions, including the main message pump. More...
 
class  Win32DropTarget
 Called by the OS when various drag and drop actions are performed over a window this control is registered for. More...
 
class  FolderMonitor
 Allows monitoring a file system folder for changes. More...
 
class  Win32Platform
 Contains the main message loop. More...
 
struct  NativeCursorData
 Encapsulate native cursor data so we can avoid including windows.h as it pollutes the global namespace. More...
 
struct  NativeDropTargetData
 Encapsulate drop target data so we can avoid including windows.h as it pollutes the global namespace. More...
 

Enumerations

enum  PlatformCursorType {
  Arrow, Wait, IBeam, Help,
  Hand, SizeAll, SizeNESW, SizeNS,
  SizeNWSE, SizeWE
}
 Contains values representing default mouse cursor types. More...
 
enum  NonClientAreaBorderType {
  TopLeft, Top, TopRight, Left,
  Right, BottomLeft, Bottom, BottomRight
}
 Contains values reprenting window non client areas. More...
 
enum  OSMouseButton { Left, Middle, Right, Count }
 Types of mouse buttons provided by the OS. More...
 
enum  OSDropType { FileList, None }
 Type of drop event type. More...
 
enum  FolderChange {
  FileName = 0x0001, DirName = 0x0002, Attributes = 0x0004, Size = 0x0008,
  LastWrite = 0x0010, LastAccess = 0x0020, Creation = 0x0040, Security = 0x0080
}
 Types of notifications we would like to receive when we start a FolderMonitor on a certain folder. More...
 

Enumeration Type Documentation

enum FolderChange
strong

Types of notifications we would like to receive when we start a FolderMonitor on a certain folder.

Enumerator
FileName 

Called when filename changes.

DirName 

Called when directory name changes.

Attributes 

Called when attributes changes.

Size 

Called when file size changes.

LastWrite 

Called when file is written to.

LastAccess 

Called when file is accessed.

Creation 

Called when file is created.

Security 

Called when file security descriptor changes.

enum NonClientAreaBorderType
strong

Contains values reprenting window non client areas.

Note
These are used for things like resize/move and tell the OS where each of those areas are on our window.
enum OSDropType
strong

Type of drop event type.

This is used when dragging items over drop targets.

enum OSMouseButton
strong

Types of mouse buttons provided by the OS.

enum PlatformCursorType
strong

Contains values representing default mouse cursor types.