Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

VCF::LibraryApplication Class Reference

Class LibraryApplication documentation. More...

#include <vcf/ApplicationKit/LibraryApplication.h>

Inheritance diagram for VCF::LibraryApplication:

VCF::AbstractApplication VCF::Component VCF::ObjectWithCallbacks VCF::Object List of all members.

Public Member Functions

 LibraryApplication ()
virtual ~LibraryApplication ()
virtual bool initRunningApplication ()
 This happens after the Application object is constructed, after the initialize() method, and just before the app's run() method is called successful.
virtual void terminateRunningApplication ()
 terminates the running application.
virtual void setName (const String &name)
 sets the name of the component.
virtual GraphicsResourceBundlegetResourceBundle ()
 This returns the application's resource bundle.

Static Public Member Functions

static Enumerator< LibraryApplication * > * getRegisteredLibraries ()
 gets a collection of named libraries that have been registered
static void registerLibrary (LibraryApplication *libraryApp)
static void unRegisterLibrary (LibraryApplication *libraryApp)
static LibraryApplicationgetRegisteredLibraryApplication (const String &libName)
static void load (LibraryApplication *libraryApp)
static void unload (LibraryApplication *libraryApp)
static void initLibraryRegistrar ()
static void clearLibraryRegistrar ()

Protected Attributes

GraphicsResourceBundleresourceBundle_

Static Protected Attributes

static std::map< String, LibraryApplication * > * namedLibraryAppMap
static EnumeratorMapContainer<
std::map< String, LibraryApplication * >,
LibraryApplication * > * 
namedLibAppContainer

Detailed Description

Class LibraryApplication documentation.


Constructor & Destructor Documentation

VCF::LibraryApplication::LibraryApplication  ) 
 

virtual VCF::LibraryApplication::~LibraryApplication  )  [virtual]
 


Member Function Documentation

static void VCF::LibraryApplication::clearLibraryRegistrar  )  [static]
 

static Enumerator<LibraryApplication*>* VCF::LibraryApplication::getRegisteredLibraries  )  [static]
 

gets a collection of named libraries that have been registered

static LibraryApplication* VCF::LibraryApplication::getRegisteredLibraryApplication const String libName  )  [static]
 

virtual GraphicsResourceBundle* VCF::LibraryApplication::getResourceBundle  )  [virtual]
 

This returns the application's resource bundle.

If the application in question is the application instance that represents the running process/program ( in other words, the instance returned by Application::getRunningInstance() ) then the resource bundle returned is the same that you would get by calling System::getResourceBundle(). However, if the application instance is a LibraryApplication, then the resource bundle is unique to that library, and independant from that of the main application's resource bundle.

This is re-implemented in LibraryApplication class.

Reimplemented from VCF::AbstractApplication.

static void VCF::LibraryApplication::initLibraryRegistrar  )  [static]
 

virtual bool VCF::LibraryApplication::initRunningApplication  )  [inline, virtual]
 

This happens after the Application object is constructed, after the initialize() method, and just before the app's run() method is called successful.

if false, it calls terminate() and then kills the app process. this method also builds the accellerator table used for keyboard shortcuts

Returns:
bool this tells whether or not the initialization of the application was

Implements VCF::AbstractApplication.

static void VCF::LibraryApplication::load LibraryApplication libraryApp  )  [static]
 

static void VCF::LibraryApplication::registerLibrary LibraryApplication libraryApp  )  [static]
 

virtual void VCF::LibraryApplication::setName const String name  )  [virtual]
 

sets the name of the component.

For naming conventions/rules please see getName().

Reimplemented from VCF::Component.

virtual void VCF::LibraryApplication::terminateRunningApplication  )  [inline, virtual]
 

terminates the running application.

This is called during normal shutdown of an application object. You should override this function if your application created resources and release those resources here.

Implements VCF::AbstractApplication.

static void VCF::LibraryApplication::unload LibraryApplication libraryApp  )  [static]
 

static void VCF::LibraryApplication::unRegisterLibrary LibraryApplication libraryApp  )  [static]
 


Member Data Documentation

EnumeratorMapContainer<std::map<String,LibraryApplication*>, LibraryApplication*>* VCF::LibraryApplication::namedLibAppContainer [static, protected]
 

std::map<String,LibraryApplication*>* VCF::LibraryApplication::namedLibraryAppMap [static, protected]
 

GraphicsResourceBundle* VCF::LibraryApplication::resourceBundle_ [protected]
 


The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information