ATK Constants

From ATK Wiki

ATK uses constants (those uppercase things like AF_HIDE) in several occasions. This page tries to document
most of them.

Contents
1 Flags
2 Debug flags
3 Action results
4 Authentication results
5 Recordlist flags
6 Session flags
7 HTML page flags
8 Database constants
9 Load Types
10 Storage Types
11 Trigger flags
12 Menu constants
13 Frame flags
14 Table flags
15 Keyboard constants

Flags
Every constant that starts with AF_ is an 'attribute flag'.

Every constant that starts with NF_ is a 'node flag'.

Every constant that starts with MF_ is a 'module flag'.

These are documented on the Flags page.

Debug flags
DEBUG_HTML
DEBUG_WARNING

Action results
The action result constants can be used in the ATK feedback mechanism.

ACTION_SUCCESS
ACTION_FAILED
ACTION_CANCELLED

Authentication results
 AUTH_SUCCESS
AUTH_UNVERIFIED
AUTH_LOCKED
AUTH_MISMATCH
AUTH_ERROR

Recordlist flags
RL_SORT_ASC
RL_SORT_DESC

RL_NO_SORT
RL_EXT_SORT
RL_NO_SEARCH
RL_NO_EXTENDED_SEARCH
RL_EMBED
RL_MRPA
RL_LOCK

Session flags
SESSION_DEFAULT
SESSION_NEW
SESSION_NESTED
SESSION_BACK
SESSION_REPLACE

HTML page flags

HTML_BODY
HTML_HEADER
HTML_DOCTYPE
HTML_ALL - Alias for HTML_BODY|HTML_HEADER
HTML_STRICT - Alias for HTML_ALL|HTML_DOCTYPE

Database constants
DB_SUCCESS
DB_UNKNOWNERROR
DB_UNKNOWNHOST
DB_UNKNOWNDATABASE
DB_ACCESSDENIED_USER
DB_ACCESSDENIED_DB

DDL_PRIMARY
DDL_UNIQUE
DDL_NOTNULL
DDL_AUTO_INCREMENT
DDL_AUTOINCREMENT - Alias for DDL_AUTO_INCREMENT
Load Types
NOLOAD
PRELOAD
POSTLOAD
ADDTOQUERY

Storage Types
NOSTORE
PRESTORE
POSTSTORE
ADDTOQUERY

Trigger flags
TRIGGER_NONE
TRIGGER_AUTO
TRIGGER_PRE
TRIGGER_POST
TRIGGER_ALL - Alias for TRIGGER_PRE|TRIGGER_POST

Menu constants
MENU_TOP
MENU_BOTTOM
MENU_LEFT
MENU_RIGHT

MENU_SCROLLABLE
MENU_UNSCROLLABLE
MENU_MULTILEVEL
MENU_NOMULTILEVEL

Frame flags
FRAMESET_HORIZONTAL
FRAMESET_VERTICAL
FRAME_SCROLL_YES
FRAME_SCROLL_NO
FRAME_SCROLL_AUTO

Table flags
TBL_HEADER
TBL_FOOTER
TBL_ALTERNATE
TBL_DATA - Alias for TBL_HEADER|TBL_ALTERNATE

TBL_LEFT
 TBL_RIGHT
TBL_CENTER
TBL_BOTTOM
TBL_MIDDLE

Keyboard constants
KB_DOWN
KB_UP
KB_LEFT
KB_RIGHT
KB_UPDOWN - Alias for KB_UP|KB_DOWN
KB_LEFTRIGHT - Alias for KB_LEFT|KB_RIGHT
KB_CURSOR - Alias for KB_UP|KB_DOWN|KB_LEFT|KB_RIGHT
KB_CTRLCURSOR

Retrieved from "http://atk-framework.com/wiki/ATK_Constants"

This page was last modified on 29 June 2007, at 06:36.