CEditor Class Reference

The main source code editing component. More...

#include <editor.h>

List of all members.

Signals

void linkProgram (void)
 The user requested to compile link the current shader.
void deactivateProgram (void)
 The current shader should be deactivated.
void aboutToQuit (void)
 Tells the application that the user wants to quit the application.

Public Member Functions

 CEditor (IShader *shader)
 Constructor.
virtual ~CEditor (void)
 Destruction.
void init (const QPoint &position)
 Initializes and shows the editor.
void shutdown (void)
 Cleans up state and prepares for destruction.
bool maybeSave (void)
 Asks the user wether to save modified documents.


Detailed Description

The main source code editing component.

This class is the top level interface to the GLSL source code editor component. It is bound to an IShader object which must be already initilized when this constructor is called. The created text editing widgets are based on the state in that shader object. The source code written with this editor will be stored in that shader object, too.


Constructor & Destructor Documentation

CEditor::CEditor ( IShader shader  ) 

Constructor.

Parameters:
shader IShader object this editor is bound to.


Member Function Documentation

void CEditor::init ( const QPoint &  position  ) 

Initializes and shows the editor.

Parameters:
position Screen coordinates of the top left corner of the editor window to appear.

bool CEditor::maybeSave ( void   ) 

Asks the user wether to save modified documents.

This call asks the user for each modified shader source code.

Returns:
Returns true if the calling operation should coninue, otherwise false. Simple: True means 'no data will get lost'.

void CEditor::linkProgram ( void   )  [signal]

The user requested to compile link the current shader.

Precondition:
When this signal is emitted, the editor has already stored the required source code in the bound IShader object.

void CEditor::deactivateProgram ( void   )  [signal]

The current shader should be deactivated.

This happens, when the user opens an existing or creates a new shader.


The documentation for this class was generated from the following files:
Generated on Sun Mar 2 17:12:32 2008 for Shader Maker by  doxygen 1.5.4