CrystalSpace

Public API Reference

CS::EditorApp::iEditor Struct Reference

The main editor interface. More...

#include <ieditor/editor.h>

Inheritance diagram for CS::EditorApp::iEditor:

List of all members.

Public Member Functions

virtual void AddMapListener (iMapListener *listener)=0
 Add a map listener.
virtual csPtr< iEditorObjectCreateEditorObject (iBase *object, wxBitmap *icon)=0
 Create an editor object wrapping the specified object.
virtual iMenuBarGetMenuBar () const =0
 Get the panel manager associated with this editor.
virtual iObjectListGetObjects ()=0
 Get the list of objects registered with the editor.
virtual iPanelManagerGetPanelManager () const =0
 Get the panel manager associated with this editor.
virtual csPtr< iProgressMeterGetProgressMeter ()=0
 Get a progress meter to be notified of the progress of an action.
virtual iObjectListGetSelection ()=0
 Get the active selection.
virtual wxWindow * GetWindow ()=0
 Get the underlying wxWindow content area of this editor.
virtual iThreadReturn * LoadLibraryFile (const char *path, const char *filename)=0
 Load a library file.
virtual iThreadReturn * LoadMapFile (const char *path, const char *filename, bool clearEngine=true)=0
 Load a map from the given VFS file.
virtual void RemoveMapListener (iMapListener *listener)=0
 Remove a map listener.
virtual void SaveMapFile (const char *path, const char *filename)=0
 Save the engine contents to the given file.

Detailed Description

The main editor interface.

Definition at line 57 of file editor.h.


Member Function Documentation

virtual void CS::EditorApp::iEditor::AddMapListener ( iMapListener listener  )  [pure virtual]

Add a map listener.

virtual csPtr<iEditorObject> CS::EditorApp::iEditor::CreateEditorObject ( iBase object,
wxBitmap *  icon 
) [pure virtual]

Create an editor object wrapping the specified object.

virtual iMenuBar* CS::EditorApp::iEditor::GetMenuBar (  )  const [pure virtual]

Get the panel manager associated with this editor.

virtual iObjectList* CS::EditorApp::iEditor::GetObjects (  )  [pure virtual]

Get the list of objects registered with the editor.

virtual iPanelManager* CS::EditorApp::iEditor::GetPanelManager (  )  const [pure virtual]

Get the panel manager associated with this editor.

virtual csPtr<iProgressMeter> CS::EditorApp::iEditor::GetProgressMeter (  )  [pure virtual]

Get a progress meter to be notified of the progress of an action.

virtual iObjectList* CS::EditorApp::iEditor::GetSelection (  )  [pure virtual]

Get the active selection.

virtual wxWindow* CS::EditorApp::iEditor::GetWindow (  )  [pure virtual]

Get the underlying wxWindow content area of this editor.

virtual iThreadReturn* CS::EditorApp::iEditor::LoadLibraryFile ( const char *  path,
const char *  filename 
) [pure virtual]

Load a library file.

virtual iThreadReturn* CS::EditorApp::iEditor::LoadMapFile ( const char *  path,
const char *  filename,
bool  clearEngine = true 
) [pure virtual]

Load a map from the given VFS file.

virtual void CS::EditorApp::iEditor::RemoveMapListener ( iMapListener listener  )  [pure virtual]

Remove a map listener.

virtual void CS::EditorApp::iEditor::SaveMapFile ( const char *  path,
const char *  filename 
) [pure virtual]

Save the engine contents to the given file.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1