Eagle Mode -
C++ API Reference

Copyright © 2010 Oliver Hamann. Homepage: http://eaglemode.sourceforge.net/

# Introduction

The Eagle Mode C++ API Reference is made of comments in the header files. Therefore this document is an index with hyperlinks to HTML-converted header files. It is structured by topics, files and sections, where a topic may contain multiple files, and a file may contain multiple sections. Often, a section stands for a symbol or class. Everything is sorted roughly from low-level to high-level. If you see this page with HTML frames, then you can use the tree links in the left frame for navigation. But in any case you can find the complete index below.

# Index

## Various Low-Level Helpers

File | Section/Symbol
emCore/emStd1.h | Version Adaptations to compilers and OSes About RTTI (Run-Time Type Information) About function attributes Byte order of the machine Integer data types Locale and UTF-8 support Logs, warnings and errors emUncopyable emUnconstructable emMin & emMax emStdComparer emAlignment
emCore/emStd2.h | Host, user, process id Time functions Error texts Files & directories Dynamic link libraries Pseudo random numbers Checksums and hash codes
emCore/emTmpFile.h | emTmpFile emTmpFileMaster
emCore/emInstallInfo.h | Install info functions
emCore/emRes.h | Resource image acquisition Resource acquisition basics

## Container Classes

File | Section/Symbol
emCore/emString.h | emString
emCore/emArray.h | Array functions emArray
emCore/emList.h | Linked-list functions emList
emCore/emAvlTree.h | AVL-tree macros emAvlTreeExample

## Smart Pointers

File | Section/Symbol
emCore/emRef.h | emRef
emCore/emCrossPtr.h | emCrossPtr emCrossPtrList

## CPU Sharing

File | Section/Symbol
emCore/emEngine.h | emEngine
emCore/emSignal.h | emSignal
emCore/emScheduler.h | emScheduler emStandardScheduler
emCore/emTimer.h | emTimer
emCore/emPriSchedAgent.h | emPriSchedAgent
emCore/emThread.h | emThreadId emThread emThreadMiniMutex emThreadEvent emThreadMutex emThreadRecursiveMutex emThreadInitMutex
emCore/emProcess.h | emProcess
emCore/emMiniIpc.h | emMiniIpcClient emMiniIpcServer

## Graphics

File | Section/Symbol
emCore/emColor.h | emColor
emCore/emImage.h | emImage
emCore/emPainter.h | emPainter
emCore/emATMatrix.h | emATMatrix emIdentityATM emInvertATM emMultiplyATM emTranslateATM emScaleATM emRotateATM emShearATM

## Recordable Data Structures

File | Section/Symbol
emCore/emRec.h | emRec emRecListener emRecAllocator emBoolRec emIntRec emDoubleRec emEnumRec emFlagsRec emStringRec emColorRec emStructRec emUnionRec emArrayRec emTArrayRec emRecReader emRecWriter emRecFileReader emRecFileWriter emRecMemReader emRecMemWriter

## Contexts and Models

File | Section/Symbol
emCore/emContext.h | emContext emRootContext
emCore/emModel.h | emModel
emCore/emVarModel.h | emVarModel
emCore/emSigModel.h | emSigModel
emCore/emVarSigModel.h | emVarSigModel

## Basic GUI Classes

File | Section/Symbol
emCore/emInput.h | emInputKey emInputEvent emInputState emInputHotkey
emCore/emCursor.h | emCursor
emCore/emClipboard.h | emClipboard
emCore/emScreen.h | emScreen
emCore/emWindow.h | emWindow emWindowPort
emCore/emView.h | emView emViewPort
emCore/emPanel.h | emPanel
emCore/emSubViewPanel.h | emSubViewPanel
emCore/emErrorPanel.h | emErrorPanel
emCore/emGUIFramework.h | MAIN_OR_WINMAIN_HERE emGUIFramework

## Toolkit Panels

File | Section/Symbol
emCore/emToolkit.h | emTkLook emTkBorder emTkLabel emTkTiling emTkGroup emTkTunnel emTkButton emTkCheckButton emTkRadioButton emTkCheckBox emTkRadioBox emTkTextField emTkScalarField emTkColorField emTkSplitter emTkDialog

## File Models & -Panels

File | Section/Symbol
emCore/emFileModel.h | emFileModel emFileModelClient
emCore/emFilePanel.h | emFilePanel
emCore/emImageFile.h | emImageFileModel emImageFilePanel
emCore/emRecFileModel.h | emRecFileModel
emCore/emConfigModel.h | emConfigModel
emCore/emCoreConfig.h | emCoreConfig

## File Panel Plugins

File | Section/Symbol
emCore/emFpPlugin.h | emFpPlugin emFpPluginFunc emFpPluginList