Erlang -- wxTopLevelWindow

# wxTopLevelWindow

###
Module

wxTopLevelWindow

###
Module Summary

Functions for wxTopLevelWindow class

###
Description

wxTopLevelWindow is a common base class for wxDialog and wxFrame. It is an abstract base class meaning that you never work with objects of this class directly, but all of its methods are also applicable for the two classes above.

Note that the instances of wxTopLevelWindow are managed by wxWidgets in the internal top level window list.

See: wxDialog, wxFrame

This class is derived (and can use functions) from: wxWindow wxEvtHandler

wxWidgets docs: wxTopLevelWindow

###
Events

Event types emitted from this class: maximize, move, show

###
Data Types

####
wxTopLevelWindow() = wx:wx_object()

###
Exports

####
getIcon(This) -> wxIcon:wxIcon()

### Types

This = wxTopLevelWindow()

Returns the standard icon of the window.

The icon will be invalid if it hadn't been previously set by setIcon/2.

See: getIcons/1

####
getIcons(This) -> wxIconBundle:wxIconBundle()

### Types

This = wxTopLevelWindow()

Returns all icons associated with the window, there will be none of them if neither setIcon/2 nor setIcons/2 had been called before.

Use getIcon/1 to get the main icon of the window.

See: wxIconBundle

####
getTitle(This) -> unicode:charlist()

### Types

This = wxTopLevelWindow()

Gets a string containing the window title.

See: setTitle/2

####
isActive(This) -> boolean()

### Types

This = wxTopLevelWindow()

Returns true if this window is currently active, i.e. if the user is currently working with it.

####
iconize(This) -> ok

### Types

This = wxTopLevelWindow()

####
iconize(This, Options :: [Option]) -> ok

### Types

This = wxTopLevelWindow()
Option = {iconize, boolean()}

Iconizes or restores the window.

Note that in wxGTK the change to the window state is not immediate, i.e. isIconized/1 will typically return false right after a call to iconize/2 and its return value will only change after the control flow returns to the event loop and the notification about the window being really iconized is received.

See: isIconized/1, Restore() (not implemented in wx), (), wxIconizeEvent

####
isFullScreen(This) -> boolean()

### Types

This = wxTopLevelWindow()

Returns true if the window is in fullscreen mode.

See: showFullScreen/3

####
isIconized(This) -> boolean()

### Types

This = wxTopLevelWindow()

Returns true if the window is iconized.

####
isMaximized(This) -> boolean()

### Types

This = wxTopLevelWindow()

Returns true if the window is maximized.

####
maximize(This) -> ok

### Types

This = wxTopLevelWindow()

####
maximize(This, Options :: [Option]) -> ok

### Types

This = wxTopLevelWindow()
Option = {maximize, boolean()}

Maximizes or restores the window.

Note that, just as with iconize/2, the change to the window state is not immediate in at least wxGTK port.

See: Restore() (not implemented in wx), iconize/2

####
requestUserAttention(This) -> ok

### Types

This = wxTopLevelWindow()

####
requestUserAttention(This, Options :: [Option]) -> ok

### Types

This = wxTopLevelWindow()
Option = {flags, integer()}

Use a system-dependent way to attract users attention to the window when it is in background.

flags may have the value of either ?wxUSER_ATTENTION_INFO (default) or ?wxUSER_ATTENTION_ERROR which results in a more drastic action. When in doubt, use the default value.

Note: This function should normally be only used when the application is not already in foreground.

This function is currently implemented for Win32 where it flashes the window icon in the taskbar, and for wxGTK with task bars supporting it.

####
setIcon(This, Icon) -> ok

### Types

This = wxTopLevelWindow()
Icon = wxIcon:wxIcon()

Sets the icon for this window.

Remark: The window takes a 'copy' of icon, but since it uses reference counting, the copy is very quick. It is safe to delete icon after calling this function.

Note: In wxMSW, icon must be either 16x16 or 32x32 icon.

See: wxIcon, setIcons/2

####
setIcons(This, Icons) -> ok

### Types

This = wxTopLevelWindow()
Icons = wxIconBundle:wxIconBundle()

Sets several icons of different sizes for this window: this allows using different icons for different situations (e.g.

task switching bar, taskbar, window title bar) instead of scaling, with possibly bad looking results, the only icon set by setIcon/2.

Note: In wxMSW, icons must contain a 16x16 or 32x32 icon, preferably both.

See: wxIconBundle

####
centerOnScreen(This) -> ok

### Types

This = wxTopLevelWindow()

####
centreOnScreen(This) -> ok

### Types

This = wxTopLevelWindow()

####
centerOnScreen(This, Options :: [Option]) -> ok

### Types

This = wxTopLevelWindow()
Option = {dir, integer()}

See: centreOnScreen/2.

####
centreOnScreen(This, Options :: [Option]) -> ok

### Types

This = wxTopLevelWindow()
Option = {dir, integer()}

Centres the window on screen.

See: wxWindow:centreOnParent/2

####
setShape(This, Region) -> boolean()

### Types

This = wxTopLevelWindow()
Region = wxRegion:wxRegion() | wxGraphicsPath:wxGraphicsPath()

If the platform supports it, sets the shape of the window to that depicted by region.

The system will not display or respond to any mouse event for the pixels that lie outside of the region. To reset the window to the normal rectangular shape simply call setShape/2 again with an empty wxRegion. Returns true if the operation is successful.

This method is available in this class only since wxWidgets 2.9.3, previous versions only provided it in wxTopLevelWindow.

Note that windows with non default shape have a fixed size and can't be resized using wxWindow:setSize/6.

####
setTitle(This, Title) -> ok

### Types

This = wxTopLevelWindow()
Title = unicode:chardata()

Sets the window title.

See: getTitle/1

####
showFullScreen(This, Show) -> boolean()

### Types

This = wxTopLevelWindow()
Show = boolean()

####
showFullScreen(This, Show, Options :: [Option]) -> boolean()

### Types

This = wxTopLevelWindow()
Show = boolean()
Option = {style, integer()}

Depending on the value of show parameter the window is either shown full screen or restored to its normal state.

style is a bit list containing some or all of the following values, which indicate what elements of the window to hide in full-screen mode:

This function has not been tested with MDI frames.

Note: Showing a window full screen also actually wxWindow:show/2s the window if it isn't shown.

See: EnableFullScreenView() (not implemented in wx), isFullScreen/1