Erlang logo
User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 1.3


Expand All
Contract All

Table of Contents

wxCaret

MODULE

wxCaret

MODULE SUMMARY

See external documentation: wxCaret.

DESCRIPTION

See external documentation: wxCaret.

DATA TYPES

wxCaret()

An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

EXPORTS

new(Window, Size) -> wxCaret()

Types:

Window = wxWindow() (see module wxWindow)
Size = {W::integer(), H::integer()}

new(Window, Width, Height) -> wxCaret()

Types:

Window = wxWindow() (see module wxWindow)
Width = integer()
Height = integer()

create(This, Window, Size) -> boolean()

Types:

This = wxCaret()
Window = wxWindow() (see module wxWindow)
Size = {W::integer(), H::integer()}

create(This, Window, Width, Height) -> boolean()

Types:

This = wxCaret()
Window = wxWindow() (see module wxWindow)
Width = integer()
Height = integer()

getBlinkTime() -> integer()

getPosition(This) -> {X::integer(), Y::integer()}

Types:

This = wxCaret()

getSize(This) -> {W::integer(), H::integer()}

Types:

This = wxCaret()

getWindow(This) -> wxWindow() (see module wxWindow)

Types:

This = wxCaret()

hide(This) -> ok

Types:

This = wxCaret()

isOk(This) -> boolean()

Types:

This = wxCaret()

isVisible(This) -> boolean()

Types:

This = wxCaret()

move(This, Pt) -> ok

Types:

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

move(This, X, Y) -> ok

Types:

This = wxCaret()
X = integer()
Y = integer()

setBlinkTime(Milliseconds) -> ok

Types:

Milliseconds = integer()

setSize(This, Size) -> ok

Types:

This = wxCaret()
Size = {W::integer(), H::integer()}

setSize(This, Width, Height) -> ok

Types:

This = wxCaret()
Width = integer()
Height = integer()

show(This) -> ok

Types:

This = wxCaret()

Equivalent to show(This, []).

show(This, Option::[Option]) -> ok

Types:

This = wxCaret()
Option = {show, boolean()}

destroy(This::wxCaret()) -> ok

Destroys this object, do not use object again