Skip to content

CCWin API

Jump to bottom Edit New page
8coon edited this page Aug 2, 2015 · 7 revisions
<style>.gray_text { color: gray; }</style>

Types

void
tuple
function
method
term
bool
int
number
string
thread
table
array
color
message
version
effect
size
canvas
Widget
Container
Form
FormWidget
Label
Button
Edit
ScrollBar
Panel
ListView
PopupMenu
MenuBar
MenuBarItem
Brush
PaintBox
FileListView

Modules

os
os.shell
os.widgets
os.widgets.FileListView
os.widgets.PaintBox
os.widgets.MenuBar
os.widgets.PopupMenu
os.widgets.ListView
os.widgets.Panel
os.widgets.ScrollBar
os.widgets.Edit
os.widgets.Button
os.widgets.Label

Types


void

Undefined
Back to top↑

tuple

LUA Tuple
Back to top↑

function

LUA Function
Back to top↑

method

LUA Function which expects an object to be passed as the first argument
Inherited from: function

Methods

Inherited from: function

Back to top↑

term

ComputerCraft Term object
Back to top↑

bool

Boolean
Back to top↑

int

Integer
Back to top↑

number

Number (both integer and float values)
Back to top↑

string

String
Back to top↑

thread

LUA Thread
Back to top↑

table

LUA Table
Back to top↑

array

LUA Arranged Table (with integer indexes starting from 1)
Inherited from: table

Methods

Inherited from: table

Back to top↑

color

Inherited from: int

Methods

Inherited from: int

Back to top↑

message

Message object

Fields

string msg Values: char, key, mouse_click, mouse_drag, mouse_scroll, refresh
string char
int key
int button
int x
int y
int n
Inherited from: table

Methods

Inherited from: table

Back to top↑

version

Version object

Fields

number build
string value
Inherited from: table

Methods

Inherited from: table

Back to top↑

effect

Effect object
Inherited from: table

Methods

color getbgcolor(effect self, effect self, int x, int y, color bgcolor, color forecolor, string char)
color getforecolor(effect self, effect self, int x, int y, color bgcolor, color forecolor, string char)
string getchar(effect self, effect self, int x, int y, color bgcolor, color forecolor, string char)
Inherited from: table

Back to top↑

size

Fields

int x
int y
Inherited from: table

Methods

Inherited from: table

Back to top↑

canvas

Canvas class.

Fields

size size
size cursorPos
array data
color bgcolor
color forecolor
bool autoScroll
bool showCursor
bool cursorBlink
effect effect
Inherited from: table

Methods

[broken] void render(canvas self, int left, int top, bool changeBlinking)
void clear(canvas self)
[broken] canvas duplicate(canvas self)
canvas scale(canvas self, int sizeX, int sizeY)
void write(canvas self, string str)
void fillrect(canvas self, int left, int top, int width, int height, color bgcolor)
[broken] void print(canvas self, string str)
void draw(canvas self, int left, int top, canvas graphic, void arg1, bool transparent, color transColor)
void point(canvas self, int x, int y, string char)
[broken] void scroll(canvas self, int n)
void setCursorPos(canvas self, int x, int y)
tuple getCursorPos(canvas self)
size getSize(canvas self)
Inherited from: table

Back to top↑

Widget

An abstract widget stub.

Fields

Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table

Methods

void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table

Back to top↑

Container

An abstract container stub.

Fields

table widgets
canvas canvas
Widget focusedWidget
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table

Methods

canvas getCanvas(Container self)
Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table

Back to top↑

Form

Form class.

Fields

string style
bool controlBox
color bgcolor
table os
int left Values: 0
int top Values: 0
bool drawTitle
Inherited from: Container
table widgets
canvas canvas
Widget focusedWidget
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table

Methods

void show(Form self)
Inherited from: Container
canvas getCanvas(Container self)
Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table

Back to top↑

FormWidget

Fields

int left
int top
int height
int width
color bgcolor
color forecolor
bool focused
bool visible
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table

Methods

Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table

Back to top↑

Label

Fields

string caption
string align
bool multiline
Inherited from: FormWidget
int left
int top
int height
int width
color bgcolor
color forecolor
bool focused
bool visible
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table

Methods

Inherited from: FormWidget
Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table

Back to top↑

Button

Fields

string caption
string align
color forecolor2
Inherited from: FormWidget
int left
int top
int height
int width
color bgcolor
color forecolor
bool focused
bool visible
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table

Methods

Inherited from: FormWidget
Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table

Back to top↑

Edit

Fields

string text
string align
int cursor
Inherited from: FormWidget
int left
int top
int height
int width
color bgcolor
color forecolor
bool focused
bool visible
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table

Methods

Inherited from: FormWidget
Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table

Back to top↑

ScrollBar

Fields

int value
int min
int max
int step
bool vertical
Inherited from: FormWidget
int left
int top
int height
int width
color bgcolor
color forecolor
bool focused
bool visible
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table

Methods

Inherited from: FormWidget
Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table

Back to top↑

Panel

Fields

string style Values: none
method onBeforeRefresh
Inherited from: Container
table widgets
canvas canvas
Widget focusedWidget
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table
Inherited from: FormWidget
int left
int top
int height
int width
color bgcolor
color forecolor
bool focused
bool visible
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table

Methods

Inherited from: Container
canvas getCanvas(Container self)
Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table
Inherited from: FormWidget
Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table

Back to top↑

ListView

Fields

array list
array selectedList
bool showScroll
int offset
function contextMenuConstructor
Inherited from: Panel
string style Values: none
method onBeforeRefresh
Inherited from: Container
table widgets
canvas canvas
Widget focusedWidget
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table
Inherited from: FormWidget
int left
int top
int height
int width
color bgcolor
color forecolor
bool focused
bool visible
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table

Methods

void reposition(ListView self, int height, int width)
void drawItem(ListView self, int index, bool selected)
int getMax(ListView self)
int getItemAt(ListView self, int x, int y)
Inherited from: Panel
Inherited from: Container
canvas getCanvas(Container self)
Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table
Inherited from: FormWidget
Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table

Back to top↑

PopupMenu

Fields

bool showing
array list
Inherited from: Container
table widgets
canvas canvas
Widget focusedWidget
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table
Inherited from: FormWidget
int left
int top
int height
int width
color bgcolor
color forecolor
bool focused
bool visible
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table

Methods

Inherited from: Container
canvas getCanvas(Container self)
Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table
Inherited from: FormWidget
Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table

Back to top↑

MenuBar

Fields

array items
bool alignTop
Inherited from: Panel
string style Values: none
method onBeforeRefresh
Inherited from: Container
table widgets
canvas canvas
Widget focusedWidget
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table
Inherited from: FormWidget
int left
int top
int height
int width
color bgcolor
color forecolor
bool focused
bool visible
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table

Methods

Inherited from: Panel
Inherited from: Container
canvas getCanvas(Container self)
Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table
Inherited from: FormWidget
Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table

Back to top↑

MenuBarItem

Fields

string name
method onClick

Back to top↑

Brush

Fields

color bgcolor
color forecolor
string char

Back to top↑

PaintBox

Fields

int pheight
int pwidth
array widgets
Brush brush
Inherited from: FormWidget
int left
int top
int height
int width
color bgcolor
color forecolor
bool focused
bool visible
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table

Methods

Inherited from: FormWidget
Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table

Back to top↑

FileListView

Fields

string path
bool firstRefresh
array history
bool use_history
table icon_buffer
bool hide_lnk_ext
bool dirOnly
Inherited from: ListView
array list
array selectedList
bool showScroll
int offset
function contextMenuConstructor
Inherited from: Panel
string style Values: none
method onBeforeRefresh
Inherited from: Container
table widgets
canvas canvas
Widget focusedWidget
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table
Inherited from: FormWidget
int left
int top
int height
int width
color bgcolor
color forecolor
bool focused
bool visible
Inherited from: Widget
Widget parent
int lastZOrder
int zOrder
string name
method onRefresh
method onClick
method onPopup
method onMouseClick
method onMouseDrag
method onKeyPress
Inherited from: table

Methods

canvas getIcon(FileListView self, table item)
void refreshList(FileListView self)
void navigate(FileListView self, string path, bool addToHistory, table _os)
void goBack(FileListView self)
Inherited from: ListView
void reposition(ListView self, int height, int width)
void drawItem(ListView self, int index, bool selected)
int getMax(ListView self)
int getItemAt(ListView self, int x, int y)
Inherited from: Panel
Inherited from: Container
canvas getCanvas(Container self)
Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table
Inherited from: FormWidget
Inherited from: Widget
void refresh(Widget self)
void mouseClick(Widget self, int button, int x, int y)
void mouseDrag(Widget self, int button, int x, int y)
void keyPress(Widget self, int key, string char)
Inherited from: table

Back to top↑

Modules

os

void sendMessage(int hwnd, message message)

message getMessage(int hwnd)

tuple pullEvent(string filter)

tuple pullEventRaw()

void startTimer(int timeout, function onTimer)

array getValidHWNDList(bool onlyInTaskbar)

void setActiveProcess(int hwnd)

int getActiveProcess()

[deprecated] void redirectTerm(term obj)

[deprecated] void restoreTerm()

void killProcess(int hwnd)

array getRegistryBranches()

array getRegistryBranchKeys(string branch)

string getRegistryKeyValue(string branch, string key, string default)

void setRegistryKeyValue(string branch, string key, string value)

[deprecated] array listInstalledSoftware()

version getVersion()

string extractFilePath(string fileName)

string extractFileName(string fileName)

string extractRealFileName(string fileName)

void messageBox(string uType, string text, string caption, array buttons, string defText) - Blocks all threads in current application and shows message box. If you pass "input" in uType, an inputbox will be shown.

void hideMessageBox()

table getProcessInfo(int pid)

int getCurrentProcess()

string getSystemPath()

void copyToClipboard(void data, string dType)

void pasteFromClipboard(string dType)

void applyMagic(effect effect) - Apply new canvas effect to the whole screen. The previous effect will be overridden.

effect getMagic() - Get current screen canvas effect.

[broken] void setCaretPos(int x, int y)

[broken] void showCaret()

[broken] void hideCaret()

[broken] void setCaretColor(color color)

int findWindowByTitle(string title)

int findWindowByFileName(string fname)

[deprecated] void loadAPI(string arg1)

[deprecated] void unloadAPI(string arg1)

number time()

number clock()

[broken] int getETime()

int getProcessUsedMemory(int pid, int MAXDEPTH)


Back to top↑

os.shell

int run(string command)

string expandEnvVar(string envvar)

void shutdown()

void restart(bool bootToShell)


Back to top↑

os.widgets


Back to top↑

os.widgets.FileListView

FileListView Create(Container _parent, string name)


Back to top↑

os.widgets.PaintBox

PaintBox Create(Container _parent, string name)


Back to top↑

os.widgets.MenuBar

MenuBar Create(Container _parent, string name)

MenuBarItem CreateItem(string _name, method _onClick)


Back to top↑

os.widgets.PopupMenu

ListView Create()


Back to top↑

os.widgets.ListView

ListView Create(Container _parent, string name)


Back to top↑

os.widgets.Panel

Panel Create(Container _parent, string name)


Back to top↑

os.widgets.ScrollBar

ScrollBar Create(Container _parent, string name)


Back to top↑

os.widgets.Edit

Edit Create(Container _parent, string name)


Back to top↑

os.widgets.Button

Button Create(Container _parent, string name)


Back to top↑

os.widgets.Label

Label Create(Container _parent, string name)


Back to top↑

Add a custom footer
Add a custom sidebar
Clone this wiki locally