jXGlobals.h File Reference

#include <jx-af/jcore/jGlobals.h>
#include "jXConstants.h"
#include "JXApplication.h"

Include dependency graph for jXGlobals.h:

This graph shows which files directly or indirectly include this file:

Functions
JXApplication *	JXGetApplication ()
JXAssert *	JXGetAssertHandler ()
bool	JXGetComposeRuleList (JXComposeRuleList **ruleList)
JXSharedPrefsManager *	JXGetSharedPrefsManager ()
JXDocumentManager *	JXGetDocumentManager ()
JXHelpManager *	JXGetHelpManager ()
JXDockManager *	JXGetDockManager ()
bool	JXGetDockManager (JXDockManager **dockMgr)
bool	JXGetMDIServer (JXMDIServer **server)
JXWebBrowser *	JXGetWebBrowser ()
JXSpellChecker *	JXGetSpellChecker ()
JXDirector *	JXGetPersistentWindowOwner ()
JXSearchTextDialog *	JXGetSearchTextDialog ()
bool	JXGetProgramDataDirectories (const JUtf8Byte *dirName, JString *sysDir, JString *userDir)
const JUtf8Byte *	JXGetInvisibleWindowClass ()
const JUtf8Byte *	JXGetDockWindowClass ()
void	JXCreateDefaultDocumentManager (const bool wantShortcuts=true)
void	JXInitHelp ()
void	JXSetDocumentManager (JXDocumentManager *docManager)
void	JXSetMDIServer (JXMDIServer *server)
void	JXSetSearchTextDialog (JXSearchTextDialog *dlog)
void	JXCreateGlobals (JXApplication *app, const JUtf8Byte *appSignature, const JUtf8Byte **defaultStringData)
void	JXCloseDirectors ()
void	JXDeleteGlobals1 ()
void	JXDeleteGlobals2 ()
void	JXSuspendPersistentWindows ()
void	JXResumePersistentWindows ()
bool	JXGetApplication (JXApplication **app)
bool	JXGetDocumentManager (JXDocumentManager **docManager)
bool	JXGetHelpManager (JXHelpManager **helpMgr)
bool	JXGetSearchTextDialog (JXSearchTextDialog **dlog)
void	JXSetDockManager (JXDockManager *dockMgr)

Function Documentation

JXCloseDirectors()

void JXCloseDirectors

(

)

Called before closing JXDisplays.

JXCreateDefaultDocumentManager()

void JXCreateDefaultDocumentManager

(

const bool

wantShortcuts

)

This is provided for convenience for all the programs that do not need a derived class of JXDocumentManager.

JXCreateGlobals()

void JXCreateGlobals	(	JXApplication *	app,
		const JUtf8Byte *	appSignature,
		const JUtf8Byte **	defaultStringData
	)

JXDeleteGlobals1()

void JXDeleteGlobals1

(

)

Called after closing JXDisplays, before deleting idle and urgent tasks.

JXDeleteGlobals2()

void JXDeleteGlobals2

(

)

Called after deleting idle and urgent tasks.

JXGetApplication() [1/2]

JXApplication * JXGetApplication

(

)

JXGetApplication() [2/2]

bool JXGetApplication

(

JXApplication **

app

)

JXGetAssertHandler()

JXAssert * JXGetAssertHandler

(

)

JXGetComposeRuleList()

bool JXGetComposeRuleList

(

JXComposeRuleList **

ruleList

)

JXGetDockManager() [1/2]

JXDockManager * JXGetDockManager

(

)

This function calls assert() if JXSetDockManager() has not been called.

JXGetDockManager() [2/2]

bool JXGetDockManager

(

JXDockManager **

dockMgr

)

This version returns false if JXSetDockManager() has not been called.

JXGetDockWindowClass()

const JUtf8Byte * JXGetDockWindowClass

(

)

JXGetDocumentManager() [1/2]

JXDocumentManager * JXGetDocumentManager

(

)

This function calls assert() if JXSetDocumentManager() has not been called. We do this because JXDocuments cannot be used otherwise.

JXGetDocumentManager() [2/2]

bool JXGetDocumentManager

(

JXDocumentManager **

docManager

)

JXGetHelpManager() [1/2]

JXHelpManager * JXGetHelpManager

(

)

This function calls assert() if JXInitHelp() has not been called. We do this because the help system cannot be used otherwise.

JXGetHelpManager() [2/2]

bool JXGetHelpManager

(

JXHelpManager **

helpMgr

)

This version returns false if the help system has not been initialized.

JXGetInvisibleWindowClass()

const JUtf8Byte * JXGetInvisibleWindowClass

(

)

JXGetMDIServer()

bool JXGetMDIServer

(

JXMDIServer **

server

)

JXGetPersistentWindowOwner()

JXDirector * JXGetPersistentWindowOwner

(

)

This should be the supervisor of all persistent windows whose existence should not keep the application running.

JXGetProgramDataDirectories()

bool JXGetProgramDataDirectories	(	const JUtf8Byte *	dirName,
		JString *	sysDir,
		JString *	userDir
	)

Returns the full paths of the system and user directories in which the program should create its private directories. dirName is appended to each one for convenience.

Returns false if the user doesn't have a home directory, in which case userDir is empty.

Does not check if either directory exists.

JXGetSearchTextDialog() [1/2]

JXSearchTextDialog * JXGetSearchTextDialog

(

)

JXGetSearchTextDialog() [2/2]

bool JXGetSearchTextDialog

(

JXSearchTextDialog **

dlog

)

JXGetSharedPrefsManager()

JXSharedPrefsManager * JXGetSharedPrefsManager

(

)

JXGetSpellChecker()

JXSpellChecker * JXGetSpellChecker

(

)

JXGetWebBrowser()

JXWebBrowser * JXGetWebBrowser

(

)

JXInitHelp()

void JXInitHelp

(

)

Creates JXHelpManager.

JXResumePersistentWindows()

void JXResumePersistentWindows

(

)

JXSetDockManager()

void JXSetDockManager

(

JXDockManager *

dockMgr

)

Automatically called by JXMDIServer.

After calling this function, we own the object and will delete it when the program terminates.

JXSetDocumentManager()

void JXSetDocumentManager

(

JXDocumentManager *

docManager

)

The application code must call this exactly once if it uses JXDocument. We don't create JXDocumentManager automatically because one may need a derived class.

After calling this function, we own the object and will delete it when the program terminates.

JXSetMDIServer()

void JXSetMDIServer

(

JXMDIServer *

server

)

Automatically called by JXMDIServer.

After calling this function, we own the object and will delete it when the program terminates.

JXSetSearchTextDialog()

void JXSetSearchTextDialog

(

JXSearchTextDialog *

dlog

)

Automatically called by JXSearchTextDialog.

After calling this function, we own the object and will delete it when the program terminates.

JXSuspendPersistentWindows()

void JXSuspendPersistentWindows

(

)