AxBookModule Class Reference

A module for dealing with book files. More...

#include <ax_resource/ax_module_book.h>

Inheritance diagram for AxBookModule:

AxModule List of all members.

Public Member Functions

 AxBookModule ()
 Constructor.
 ~AxBookModule ()
 Destructor.
virtual bool OnInit ()
 Called on IDE startup, before the main window has been created.
virtual bool OnInitUI ()
 Called on application startup, after the main window has been created.
virtual void OnExit ()
 Called just before program termination, but only if OnInit succeeded.
virtual bool LoadConfig (wxConfigBase &config)
 Read config settings.
virtual bool SaveConfig (wxConfigBase &config)
 Write config settings.
virtual bool OnCloseMainWindow ()
 Called just before the frame is closed.
virtual bool OnSearch (const wxString &WXUNUSED(searchString), int WXUNUSED(flags), AxResourceLibrary *WXUNUSED(library))
 Allows app to search amongst its own objects.
virtual bool IsFileSupported (const wxString &filename)
 Is this file supported?
virtual AxResourceLoadResource (const wxString &filename)
 Load the file into a new AxResource.
virtual bool AggregateFiles (AxResourceLibrary *library, wxArrayString &files, bool checkIfFileLoaded)
 Aggregate any files that belong together and add to resources.
virtual AxActivatorCreateActivator (AxResourceLibrary *library, AxResource *resource)
 Create an activator for the resource, for creating views and further menu items.

Static Public Member Functions

static bool LoadEpubBookInfo (const wxString &filename, AxBookResource &resource, bool makeThumbnail, const wxSize &thumbnailImageSize, bool &foundCoverImage)
 Load information from epub file.

Detailed Description

A module for dealing with book files.


Constructor & Destructor Documentation

AxBookModule::AxBookModule (  ) 

Constructor.

AxBookModule::~AxBookModule (  )  [inline]

Destructor.


Member Function Documentation

bool AxBookModule::OnInit (  )  [virtual]

Called on IDE startup, before the main window has been created.

Implements AxModule.

bool AxBookModule::OnInitUI (  )  [virtual]

Called on application startup, after the main window has been created.

Implements AxModule.

void AxBookModule::OnExit (  )  [virtual]

Called just before program termination, but only if OnInit succeeded.

Implements AxModule.

bool AxBookModule::LoadConfig ( wxConfigBase &  config  )  [virtual]

Read config settings.

bool AxBookModule::SaveConfig ( wxConfigBase &  config  )  [virtual]

Write config settings.

virtual bool AxBookModule::OnCloseMainWindow (  )  [inline, virtual]

Called just before the frame is closed.

Returning false vetoes the frame/app close.

Reimplemented from AxModule.

virtual bool AxBookModule::OnSearch ( const wxString &  WXUNUSED(searchString),
int   WXUNUSED(flags),
AxResourceLibrary WXUNUSED(library) 
) [inline, virtual]

Allows app to search amongst its own objects.

Call AxResourceLibrary::AddSearchItem for each item.

Reimplemented from AxModule.

bool AxBookModule::IsFileSupported ( const wxString &  filename  )  [virtual]

Is this file supported?

AxResource * AxBookModule::LoadResource ( const wxString &  filename  )  [virtual]

Load the file into a new AxResource.

bool AxBookModule::AggregateFiles ( AxResourceLibrary library,
wxArrayString &  files,
bool  checkIfFileLoaded 
) [virtual]

Aggregate any files that belong together and add to resources.

Return false if you don't aggregate any files.

AxActivator * AxBookModule::CreateActivator ( AxResourceLibrary library,
AxResource resource 
) [virtual]

Create an activator for the resource, for creating views and further menu items.

bool AxBookModule::LoadEpubBookInfo ( const wxString &  filename,
AxBookResource resource,
bool  makeThumbnail,
const wxSize &  thumbnailImageSize,
bool &  foundCoverImage 
) [static]

Load information from epub file.


The documentation for this class was generated from the following files:
Generated on Wed May 6 19:20:20 2009 for AxTk by  doxygen 1.5.1