AP_Interface Class Reference

#include <AP_Interface.h>

Inheritance diagram for AP_Interface:

List of all members.

Public Member Functions
	AP_Interface ()
	AP_Interface (const char *myname, const char *const *names, UI_EventMethod const *methods)
virtual	~AP_Interface ()
const UT_String &	getName () const
void	wireInterface (UI_Manager *uims)
void	unwireInterface (UI_Manager *uims)
int	parseUI (const char *filename, bool quiet=false)
int	parseUI (FILE *input, const char *inputname, bool quiet=false)
void	setValueSymbol (const char *symbol, UI_Value *value, int warn=1)
UI_Value *	getValueSymbol (const char *symbol, int create=1)
int	getValueSymbols (UT_PtrArray< const char * > &symbols, UT_PtrArray< UI_Value * > &values) const
void	setObjectSymbol (const char *symbol, UI_Object *who, int warn=1)
UI_Object *	getObjectSymbol (const char *symbol) const
UI_Feel *	getFeelSymbol (const char *symbol) const
void	removeObjectSymbol (const char *symbol)
virtual void	initApplication (UI_Manager *uims, int argc, const char **argv)
void	resetApplication ()
virtual void	handleEvent (UI_Event *event)
virtual int	saveAppData (const char *filename)
virtual int	loadAppState ()
virtual int	saveAppState ()
virtual void	saveOnCoreDump ()
virtual bool	getCoreDumpFileName (char *buffer, int unique=0)
bool	loadUIInitPrefs ()
void	saveUIInitPrefs (const char *layout_level)
bool	restoreUIInitPrefs ()
bool	getFunctionKeyScript (UI_Event *event, UT_String &script)
Static Public Member Functions
static FILE *	createPreferenceFile (const char *filename)
static FILE *	openPreferenceFile (const char *filename)
static void	setAppExitCode (int exit_code)
static int	getAppExitCode ()
Protected Member Functions
void	setForegroundOption (int onOff)
void	setXTermOption (int onOff)
void	setTheMainApplication (AP_Interface *app)
AP_Interface *	getMainApplication ()
UT_SymbolTable *	getValueTable (void) const
UT_SymbolTable *	getObjectTable (void) const
bool	getWindowGeometry (float &width, float &height, float &left, float &bottom)
virtual void	getSignalList (int *signals, int max_signals)
Protected Attributes
UT_String	myName
const char *const *	myValueNames
UI_EventMethod const *	myMethods

---

Detailed Description

Examples:

ui/cmd_ui.C.

Definition at line 34 of file AP_Interface.h.

---

Constructor & Destructor Documentation

AP_Interface::AP_Interface

(

)

AP_Interface::AP_Interface	(	const char *	myname,
		const char *const *	names,
		UI_EventMethod const *	methods
	)

virtual AP_Interface::~AP_Interface

(

)

[virtual]

---

Member Function Documentation

static FILE* AP_Interface::createPreferenceFile

(

const char *

filename

)

[static]

static int AP_Interface::getAppExitCode

(

)

[static]

virtual bool AP_Interface::getCoreDumpFileName	(	char *	buffer,
		int	unique = 0
	)			[virtual]

UI_Feel* AP_Interface::getFeelSymbol

(

const char *

symbol

)

const

bool AP_Interface::getFunctionKeyScript	(	UI_Event *	event,
		UT_String &	script
	)

AP_Interface* AP_Interface::getMainApplication

(

)

[inline, protected]

Definition at line 124 of file AP_Interface.h.

const UT_String& AP_Interface::getName

(

void

)

const [inline]

Reimplemented from UI_Object.

Definition at line 43 of file AP_Interface.h.

UI_Object* AP_Interface::getObjectSymbol

(

const char *

symbol

)

const

UT_SymbolTable* AP_Interface::getObjectTable

(

void

)

const [inline, protected]

Definition at line 131 of file AP_Interface.h.

virtual void AP_Interface::getSignalList	(	int *	signals,
		int	max_signals
	)			[protected, virtual]

UI_Value* AP_Interface::getValueSymbol	(	const char *	symbol,
		int	create = 1
	)

Examples:

ui/cmd_ui.C.

int AP_Interface::getValueSymbols	(	UT_PtrArray< const char * > &	symbols,
		UT_PtrArray< UI_Value * > &	values
	)			const

UT_SymbolTable* AP_Interface::getValueTable

(

void

)

const [inline, protected]

Definition at line 130 of file AP_Interface.h.

bool AP_Interface::getWindowGeometry	(	float &	width,
		float &	height,
		float &	left,
		float &	bottom
	)			[protected]

virtual void AP_Interface::handleEvent

(

UI_Event *

event

)

[virtual]

Reimplemented from UI_Object.

virtual void AP_Interface::initApplication	(	UI_Manager *	uims,
		int	argc,
		const char **	argv
	)			[virtual]

Reimplemented in BM_InputSelector, BM_ParmState, BM_SimpleState, and MSS_PeltSelector.

virtual int AP_Interface::loadAppState

(

)

[virtual]

bool AP_Interface::loadUIInitPrefs

(

)

static FILE* AP_Interface::openPreferenceFile

(

const char *

filename

)

[static]

int AP_Interface::parseUI	(	FILE *	input,
		const char *	inputname,
		bool	quiet = false
	)

int AP_Interface::parseUI	(	const char *	filename,
		bool	quiet = false
	)

Turns a .ui file into UI gadgets. If quiet is true, no errors or warnings are printed. If defines is specified, this allows you to pass CPP style symbols to the parser, in the form "SYMBOL=VALUE". =VALUE may be omitted.

Examples:

ui/cmd_ui.C.

void AP_Interface::removeObjectSymbol

(

const char *

symbol

)

void AP_Interface::resetApplication

(

)

bool AP_Interface::restoreUIInitPrefs

(

)

virtual int AP_Interface::saveAppData

(

const char *

filename

)

[virtual]

virtual int AP_Interface::saveAppState

(

)

[virtual]

virtual void AP_Interface::saveOnCoreDump

(

)

[virtual]

void AP_Interface::saveUIInitPrefs

(

const char *

layout_level

)

static void AP_Interface::setAppExitCode

(

int

exit_code

)

[static]

void AP_Interface::setForegroundOption

(

int

onOff

)

[protected]

void AP_Interface::setObjectSymbol	(	const char *	symbol,
		UI_Object *	who,
		int	warn = 1
	)

void AP_Interface::setTheMainApplication

(

AP_Interface *

app

)

[inline, protected]

Definition at line 120 of file AP_Interface.h.

void AP_Interface::setValueSymbol	(	const char *	symbol,
		UI_Value *	value,
		int	warn = 1
	)

Examples:

ui/cmd_ui.C.

void AP_Interface::setXTermOption

(

int

onOff

)

[protected]

void AP_Interface::unwireInterface

(

UI_Manager *

uims

)

void AP_Interface::wireInterface

(

UI_Manager *

uims

)

---

Member Data Documentation

UI_EventMethod const* AP_Interface::myMethods [protected]

Definition at line 128 of file AP_Interface.h.

UT_String AP_Interface::myName [protected]

Definition at line 126 of file AP_Interface.h.

const char* const* AP_Interface::myValueNames [protected]

Definition at line 127 of file AP_Interface.h.

---

The documentation for this class was generated from the following file:

• SI/AP_Interface.h