bionic (3) wx_misc.3erl.gz

NAME

       wx_misc - See external documentation: Misc.

DESCRIPTION

       See external documentation: Misc.

EXPORTS

       getKeyState(Key) -> boolean()

              Types:

                 Key = wx:wx_enum()

              See external documentation.
              Key  =  ?WXK_BACK | ?WXK_TAB | ?WXK_RETURN | ?WXK_ESCAPE | ?WXK_SPACE | ?WXK_DELETE | ?WXK_START |
              ?WXK_LBUTTON | ?WXK_RBUTTON | ?WXK_CANCEL | ?WXK_MBUTTON | ?WXK_CLEAR | ?WXK_SHIFT  |  ?WXK_ALT  |
              ?WXK_CONTROL  | ?WXK_MENU | ?WXK_PAUSE | ?WXK_CAPITAL | ?WXK_END | ?WXK_HOME | ?WXK_LEFT | ?WXK_UP
              | ?WXK_RIGHT | ?WXK_DOWN | ?WXK_SELECT | ?WXK_PRINT | ?WXK_EXECUTE | ?WXK_SNAPSHOT | ?WXK_INSERT |
              ?WXK_HELP   |  ?WXK_NUMPAD0  |  ?WXK_NUMPAD1  |  ?WXK_NUMPAD2  |  ?WXK_NUMPAD3  |  ?WXK_NUMPAD4  |
              ?WXK_NUMPAD5 | ?WXK_NUMPAD6 |  ?WXK_NUMPAD7  |  ?WXK_NUMPAD8  |  ?WXK_NUMPAD9  |  ?WXK_MULTIPLY  |
              ?WXK_ADD  |  ?WXK_SEPARATOR  |  ?WXK_SUBTRACT  |  ?WXK_DECIMAL | ?WXK_DIVIDE | ?WXK_F1 | ?WXK_F2 |
              ?WXK_F3 | ?WXK_F4 | ?WXK_F5 | ?WXK_F6 | ?WXK_F7 | ?WXK_F8  |  ?WXK_F9  |  ?WXK_F10  |  ?WXK_F11  |
              ?WXK_F12 | ?WXK_F13 | ?WXK_F14 | ?WXK_F15 | ?WXK_F16 | ?WXK_F17 | ?WXK_F18 | ?WXK_F19 | ?WXK_F20 |
              ?WXK_F21 |  ?WXK_F22  |  ?WXK_F23  |  ?WXK_F24  |  ?WXK_NUMLOCK  |  ?WXK_SCROLL  |  ?WXK_PAGEUP  |
              ?WXK_PAGEDOWN  |  ?WXK_NUMPAD_SPACE  |  ?WXK_NUMPAD_TAB  |  ?WXK_NUMPAD_ENTER  |  ?WXK_NUMPAD_F1 |
              ?WXK_NUMPAD_F2  |  ?WXK_NUMPAD_F3  |  ?WXK_NUMPAD_F4  |  ?WXK_NUMPAD_HOME  |  ?WXK_NUMPAD_LEFT   |
              ?WXK_NUMPAD_UP  | ?WXK_NUMPAD_RIGHT | ?WXK_NUMPAD_DOWN | ?WXK_NUMPAD_PAGEUP | ?WXK_NUMPAD_PAGEDOWN
              |   ?WXK_NUMPAD_END   |   ?WXK_NUMPAD_BEGIN   |   ?WXK_NUMPAD_INSERT   |   ?WXK_NUMPAD_DELETE    |
              ?WXK_NUMPAD_EQUAL   |   ?WXK_NUMPAD_MULTIPLY   |   ?WXK_NUMPAD_ADD   |   ?WXK_NUMPAD_SEPARATOR   |
              ?WXK_NUMPAD_SUBTRACT  |   ?WXK_NUMPAD_DECIMAL   |   ?WXK_NUMPAD_DIVIDE   |   ?WXK_WINDOWS_LEFT   |
              ?WXK_WINDOWS_RIGHT   |   ?WXK_WINDOWS_MENU  |  ?WXK_COMMAND  |  ?WXK_SPECIAL1  |  ?WXK_SPECIAL2  |
              ?WXK_SPECIAL3 | ?WXK_SPECIAL4 | ?WXK_SPECIAL5 | ?WXK_SPECIAL6 | ?WXK_SPECIAL7  |  ?WXK_SPECIAL8  |
              ?WXK_SPECIAL9 | ?WXK_SPECIAL10 | ?WXK_SPECIAL11 | ?WXK_SPECIAL12 | ?WXK_SPECIAL13 | ?WXK_SPECIAL14
              |  ?WXK_SPECIAL15  |  ?WXK_SPECIAL16  |  ?WXK_SPECIAL17  |  ?WXK_SPECIAL18  |   ?WXK_SPECIAL19   |
              ?WXK_SPECIAL20

       getMousePosition() -> {X::integer(), Y::integer()}

              See external documentation.

       getMouseState() -> wx:wx_wxMouseState()

              See external documentation.

       setDetectableAutoRepeat(Flag) -> boolean()

              Types:

                 Flag = boolean()

              See external documentation.

       bell() -> ok

              See external documentation.

       findMenuItemId(Frame, MenuString, ItemString) -> integer()

              Types:

                 Frame = wxFrame:wxFrame()
                 MenuString = unicode:chardata()
                 ItemString = unicode:chardata()

              See external documentation.

       genericFindWindowAtPoint(Pt) -> wxWindow:wxWindow()

              Types:

                 Pt = {X::integer(), Y::integer()}

              See external documentation.

       findWindowAtPoint(Pt) -> wxWindow:wxWindow()

              Types:

                 Pt = {X::integer(), Y::integer()}

              See external documentation.

       beginBusyCursor() -> ok

              Equivalent to beginBusyCursor([]).

       beginBusyCursor(Options::[Option]) -> ok

              Types:

                 Option = {cursor, wxCursor:wxCursor()}

              See external documentation.

       endBusyCursor() -> ok

              See external documentation.

       isBusy() -> boolean()

              See external documentation.

       shutdown(WFlags) -> boolean()

              Types:

                 WFlags = wx:wx_enum()

              See external documentation.
              WFlags = ?wxSHUTDOWN_POWEROFF | ?wxSHUTDOWN_REBOOT

       shell() -> boolean()

              Equivalent to shell([]).

       shell(Options::[Option]) -> boolean()

              Types:

                 Option = {command, unicode:chardata()}

              See external documentation.

       launchDefaultBrowser(Url) -> boolean()

              Types:

                 Url = unicode:chardata()

              Equivalent to launchDefaultBrowser(Url, []).

       launchDefaultBrowser(Url, Options::[Option]) -> boolean()

              Types:

                 Url = unicode:chardata()
                 Option = {flags, integer()}

              See external documentation.

       getEmailAddress() -> unicode:charlist()

              See external documentation.

       getUserId() -> unicode:charlist()

              See external documentation.

       getHomeDir() -> unicode:charlist()

              See external documentation.

       newId() -> integer()

              See external documentation.

       registerId(Id) -> ok

              Types:

                 Id = integer()

              See external documentation.

       getCurrentId() -> integer()

              See external documentation.

       getOsDescription() -> unicode:charlist()

              See external documentation.

       isPlatformLittleEndian() -> boolean()

              See external documentation.

       isPlatform64Bit() -> boolean()

              See external documentation.

       displaySize() -> {Width::integer(), Height::integer()}

              See external documentation.

       setCursor(Cursor) -> ok

              Types:

                 Cursor = wxCursor:wxCursor()

              See external documentation.

AUTHORS

       <>

                                                    wx 1.8.3                                       wx_misc(3erl)