lyx_mirror/src/frontends/xforms/FormBase.h

// -*- C++ -*-
/* This file is part of
 * ====================================================== 
 *
 *           LyX, The Document Processor
 *
 *           Copyright 2000 The LyX Team.
 *
 * ======================================================
 */

#ifndef FORMBASE_H
#define FORMBASE_H

#include "DialogBase.h"
#include "LString.h"
#include <boost/utility.hpp>
#include FORMS_H_LOCATION
#include "ButtonController.h"
#include "gettext.h"

class Buffer;
class Dialogs;
class LyXView;

#ifdef __GNUG__
#pragma interface
#endif

/** This class is an XForms GUI base class.
    It is meant to be used solely as the parent class to FormBaseBI and FormBaseBD
    @author Angus Leeming
 */
class FormBase : public DialogBase, public noncopyable {
public:
	/** Constructor.
	    #FormBase(lv, d, _("DialogName"), BUFFER_DEPENDENT, new ButtonPolicy)#
	 */
	FormBase(LyXView *, Dialogs *, string const &,
		 ButtonPolicy *, char const *, char const *);
	///
	virtual ~FormBase();

	/// Callback functions
	static  int WMHideCB(FL_FORM *, void *);
	///
	static void ApplyCB(FL_OBJECT *, long);
	///
	static void OKCB(FL_OBJECT *, long);
	///
	static void CancelCB(FL_OBJECT *, long);
	///
	static void InputCB(FL_OBJECT *, long);
	///
	static void RestoreCB(FL_OBJECT *, long);

protected: // methods
	/// Create the dialog if necessary, update it and display it.
	void show();
	/// Hide the dialog.
	virtual void hide();
	/// bool indicates if a buffer switch took place
	virtual void update(bool = false) {}
	/// Connect signals. Also perform any necessary initialisation.
	virtual void connect() = 0;
	/// Disconnect signals. Also perform any necessary housekeeping.
	virtual void disconnect() = 0;
	/// Build the dialog
	virtual void build() = 0;
	/** Filter the inputs on callback from xforms
	    Return true if inputs are valid.
	 */
	virtual bool input( FL_OBJECT *, long ) {
		return true;
	}
	/// Apply from dialog (modify or create inset)
	virtual void apply() {}
	/// OK from dialog
	virtual void ok() {
		apply();
		hide();
	}
	/// Cancel from dialog
	virtual void cancel() {
		hide();
	}
	/// Restore from dialog
	virtual void restore() {
		update();
	}
	/// Pointer to the actual instantiation of xform's form
	virtual FL_FORM * form() const = 0;

protected: // data
	/** Which LyXFunc do we use?
	    We could modify Dialogs to have a visible LyXFunc* instead and
	    save a couple of bytes per dialog.
	*/
	LyXView * lv_;
	/// Useable even in derived-class's const functions.
	mutable ButtonController bc_;
	/// Used so we can get at the signals we have to connect to.
	Dialogs * d_;
	/// Hide connection.
	Connection h_;
	/// dialog title, displayed by WM.
  	string title;
	///
	ButtonPolicy * bp_;
};


/** This class is an XForms GUI base class for Buffer Independent dialogs.
    Such dialogs do not require an update Connection although they may use
    an update() function which is also supported by restore().
 */
class FormBaseBI : public FormBase {
public:
	/// Constructor
	FormBaseBI(LyXView *, Dialogs *, string const &,
		   ButtonPolicy * bp = new OkApplyCancelPolicy,
		   char const * close = N_("Close"),
		   char const * cancel = N_("Cancel"));

protected:
	/// Connect signals
	virtual void connect();
	/// Disconnect signals
	virtual void disconnect();
};


/** This class is an XForms GUI base class for Buffer Dependent dialogs
 */
class FormBaseBD : public FormBase {
public:
	/// Constructor
	FormBaseBD(LyXView *, Dialogs *, string const &,
		   ButtonPolicy * bp = new OkApplyCancelReadOnlyPolicy,
		   char const * close = N_("Close"),
		   char const * cancel = N_("Cancel"));

protected:
	/// Connect signals
	virtual void connect();
	/// Disconnect signals
	virtual void disconnect();

	/// Update connection.
	Connection u_;
};


#endif