// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2000 The LyX Team.
+/**
+ * \file FormPreferences.h
+ * Copyright 1999-2001 Allan Rae
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * This file copyright 1999-2000
- * Allan Rae
- *======================================================*/
-/* FormPreferences.h
- * FormPreferences Interface Class
+ * \author Allan Rae
+ * \author Angus Leeming
+ *
+ * Full author contact details are available in file CREDITS
*/
#ifndef FORMPREFERENCES_H
#define FORMPREFERENCES_H
-#include <utility> // for pair
#include "FormBase.h"
-#include "Color.h"
+#include "Color.h" // NamedColor
+#include "xforms_helpers.h" // XformColor
+
+#include <boost/scoped_ptr.hpp>
+
+#include FORMS_H_LOCATION
+#include <utility> // pair
-#ifdef __GNUG_
-#pragma interface
-#endif
+class ControlPrefs;
-class Combox;
-class Command;
class Dialogs;
-class Format;
class LyXView;
-struct FD_form_colors;
-struct FD_form_converters;
-struct FD_form_formats;
-struct FD_form_inputs_misc;
-struct FD_form_interface;
-struct FD_form_language;
-struct FD_form_lnf_misc;
-struct FD_form_outer_tab;
-struct FD_form_outputs_misc;
-struct FD_form_paths;
-struct FD_form_preferences;
-struct FD_form_printer;
-struct FD_form_screen_fonts;
-struct FD_form_spellchecker;
+class RGBColor;
+struct FD_preferences;
+struct FD_preferences_colors;
+struct FD_preferences_converters;
+struct FD_preferences_formats;
+struct FD_preferences_inputs_misc;
+struct FD_preferences_interface;
+struct FD_preferences_language;
+struct FD_preferences_lnf_misc;
+struct FD_preferences_identity;
+struct FD_preferences_inner_tab;
+struct FD_preferences_outputs_misc;
+struct FD_preferences_paths;
+struct FD_preferences_printer;
+struct FD_preferences_screen_fonts;
+struct FD_preferences_spelloptions;
+
/** This class provides an XForms implementation of the FormPreferences Dialog.
- The preferences dialog allows users to set/save their preferences.
+ * The preferences dialog allows users to set/save their preferences.
*/
-class FormPreferences : public FormBaseBI {
+class FormPreferences : public FormCB<ControlPrefs, FormDB<FD_preferences> > {
public:
- /// #FormPreferences x(LyXFunc ..., Dialogs ...);#
- FormPreferences(LyXView *, Dialogs *);
- ///
- ~FormPreferences();
- ///
- static void ComboLanguageCB(int, void *, Combox *);
- ///
- static int FeedbackCB(FL_OBJECT *, int,
- FL_Coord, FL_Coord, int, void *);
+ FormPreferences();
private:
/** Redraw the form (on receipt of a Signal indicating, for example,
- that the xform colours have been re-mapped). */
+ that the xforms colours have been re-mapped). */
virtual void redraw();
/// Update the dialog.
virtual void update();
- ///
+ /// Hide the dialog.
virtual void hide();
- /// OK from dialog
- virtual void ok();
/// Apply from dialog
virtual void apply();
/// Filter the inputs -- return true if entries are valid
- virtual bool input(FL_OBJECT *, long);
+ virtual ButtonPolicy::SMInput input(FL_OBJECT *, long);
/// Build the dialog
virtual void build();
/// control which feedback message is output
- void feedback( FL_OBJECT * );
- /// The handler for the preemptive feedback
- void Feedback(FL_OBJECT *, int);
- ///
- virtual FL_FORM * form() const;
+ string const getFeedback(FL_OBJECT *);
- /** Folder specific apply functions.
- */
-
- ///
- void applyColors() const;
- ///
- void applyConverters() const;
- ///
- void applyFormats() const;
- ///
- void applyInputsMisc() const;
- ///
- void applyInterface() const;
- ///
- void applyLanguage(); // not const because calls updateLanguage!
- ///
- void applyLnFmisc() const;
- ///
- void applyOutputsMisc() const;
- ///
- void applyPaths(); // not const because calls updatePaths!
- ///
- void applyPrinter() const;
- ///
- void applyScreenFonts() const;
- ///
- void applySpellChecker(); // not const because calls updateSpellChecker!
+ /// Converters tabfolder
+ boost::scoped_ptr<FD_preferences_inner_tab> converters_tab_;
+ /// reLyX and other import/input stuff
+ boost::scoped_ptr<FD_preferences_inner_tab> inputs_tab_;
+ /// HCI configuration
+ boost::scoped_ptr<FD_preferences_inner_tab> look_n_feel_tab_;
+ /// Outputs tabfolder
+ boost::scoped_ptr<FD_preferences_inner_tab> outputs_tab_;
+ /// Spellchecker, language stuff, etc
+ boost::scoped_ptr<FD_preferences_inner_tab> lang_opts_tab_;
- /** Folder specific build functions.
+ /** Each tab folder is encapsulated in its own class.
*/
-
- ///
- void buildColors();
- ///
- void buildConverters();
- ///
- void buildFormats();
- ///
- void buildInputsMisc();
- ///
- void buildInterface();
- ///
- void buildLanguage();
- ///
- void buildLnFmisc();
- ///
- void buildOutputsMisc();
- ///
- void buildPaths();
- ///
- void buildPrinter();
- ///
- void buildScreenFonts();
- ///
- void buildSpellchecker();
- /** Folder specific feedback functions.
- */
-
- ///
- string const feedbackColors(FL_OBJECT const * const) const;
- ///
- string const feedbackConverters(FL_OBJECT const * const) const;
- ///
- string const feedbackFormats( FL_OBJECT const * const ) const;
- ///
- string const feedbackInputsMisc(FL_OBJECT const * const) const;
- ///
- string const feedbackInterface(FL_OBJECT const * const) const;
- ///
- string const feedbackLanguage(FL_OBJECT const * const) const;
- ///
- string const feedbackLnFmisc(FL_OBJECT const * const) const;
- ///
- string const feedbackOutputsMisc(FL_OBJECT const * const) const;
- ///
- string const feedbackPaths(FL_OBJECT const * const) const;
- ///
- string const feedbackPrinter(FL_OBJECT const * const) const;
- ///
- string const feedbackScreenFonts(FL_OBJECT const * const) const;
- ///
- string const feedbackSpellChecker(FL_OBJECT const * const) const;
+ class Colors {
+ public:
+ ///
+ enum GuiColors {
+ GUI_COLOR_CHOICE = FL_FREE_COL14,
+ GUI_COLOR_HUE_DIAL = FL_FREE_COL15,
+ GUI_COLOR_CURSOR = FL_FREE_COL16
+ };
+ ///
+ Colors(FormPreferences & p);
+ ///
+ FD_preferences_colors const * dialog();
+ ///
+ void apply(); // not const as modifies modifiedXformsPrefs.
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ void input(FL_OBJECT const * const);
+ ///
+ void update() { LoadBrowserLyX(); }
- /** Folder specific input functions. Not all folders require one.
- */
-
- ///
- bool inputColors(FL_OBJECT const * const);
- ///
- bool inputConverters( FL_OBJECT const * const );
- ///
- bool inputFormats( FL_OBJECT const * const );
- ///
- bool inputLanguage(FL_OBJECT const * const);
- ///
- bool inputPaths(FL_OBJECT const * const);
- ///
- bool inputScreenFonts();
- ///
- bool inputSpellChecker(FL_OBJECT const * const);
+ /// Flag whether Xforms colors have changed since last file save
+ bool modifiedXformsPrefs;
- /** Folder specific update functions.
- */
-
- ///
- void updateColors();
- ///
- void updateConverters();
- ///
- void updateFormats();
- ///
- void updateInputsMisc();
- ///
- void updateInterface();
- ///
- void updateLanguage();
- ///
- void updateLnFmisc();
- ///
- void updateOutputsMisc();
- ///
- void updatePaths();
- ///
- void updatePrinter();
- ///
- void updateScreenFonts();
- ///
- void updateSpellChecker();
+ private:
+ ///
+ void AdjustVal(int, int, double) const;
+ ///
+ void InputBrowserLyX() const;
+ ///
+ void InputHSV();
+ ///
+ void InputRGB();
+ ///
+ void LoadBrowserLyX();
+ ///
+ void Modify();
+ ///
+ void SwitchColorSpace() const;
- /** Some helper functions for specific folders.
- */
-
- ///
- void ColorsAdjustVal( int, int, double ) const;
- ///
- bool ColorsBrowserLyX() const;
- ///
- bool ColorsBrowserX11() const;
- ///
- bool ColorsDatabase() const;
- ///
- void ColorsLoadBrowserLyX();
- ///
- bool ColorsLoadBrowserX11(string const &) const;
- ///
- bool ColorsModify() const;
- ///
- bool ColorsRGB() const;
- ///
- int ColorsSearchEntry(RGB const &) const;
+ ///
+ FormPreferences & parent_;
+ ///
+ boost::scoped_ptr<FD_preferences_colors> dialog_;
+ /// A vector of LyX LColor GUI name and associated RGB color.
+ std::vector<NamedColor> lyxColorDB;
+ /// A vector of xforms color ID, RGB colors and associated name.
+ std::vector<XformsColor> xformsColorDB;
+ };
///
- bool ConvertersAdd();
- ///
- bool ConvertersBrowser();
- ///
- void ConvertersClear() const;
- ///
- bool ConvertersContainFormat( Format const &) const;
- ///
- bool ConvertersDelete();
- ///
- bool ConvertersInput();
- ///
- bool ConvertersSetCommand( Command & ) const;
- ///
- void ConvertersUpdateChoices();
+ friend class Colors;
- bool FormatsAdd();
- ///
- bool FormatsBrowser();
///
- void FormatsClear() const;
- ///
- bool FormatsDelete();
- ///
- bool FormatsInput();
+ class Converters {
+ public:
+ ///
+ Converters(FormPreferences & p);
+ ///
+ FD_preferences_converters const * dialog();
+ ///
+ void apply() const;
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ bool input(FL_OBJECT const * const);
+ ///
+ void update();
+ ///
+ void UpdateBrowser();
+ ///
+ void UpdateChoices() const;
- ///
- bool WriteableDir( string const & );
- ///
- bool ReadableDir( string const & );
- ///
- bool WriteableFile( string const &, string const & = string() );
+ private:
+ ///
+ bool Add();
+ ///
+ bool Browser();
+ ///
+ bool erase();
+ ///
+ bool Input();
+ ///
+ string const GetFrom() const;
+ ///
+ string const GetTo() const;
+ ///
+ FormPreferences & parent_;
+ ///
+ boost::scoped_ptr<FD_preferences_converters> dialog_;
+ };
///
- void setPreHandler( FL_OBJECT * ) const;
- ///
- void printWarning( string const & );
+ friend class Converters;
- /// Type definitions from the fdesign produced header file.
- FD_form_preferences * build_preferences();
- ///
- FD_form_outer_tab * build_outer_tab();
- ///
- FD_form_colors * build_colors();
///
- FD_form_converters * build_converters();
- ///
- FD_form_formats * build_formats();
- ///
- FD_form_inputs_misc * build_inputs_misc();
+ class Formats {
+ public:
+ ///
+ Formats(FormPreferences & p);
+ ///
+ FD_preferences_formats const * dialog();
+ ///
+ void apply() const;
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ bool input(FL_OBJECT const * const);
+ ///
+ void update();
+
+ private:
+ ///
+ bool Add();
+ ///
+ bool Browser();
+ ///
+ void UpdateBrowser();
+ ///
+ bool erase();
+ ///
+ bool Input();
+
+ ///
+ FormPreferences & parent_;
+ ///
+ boost::scoped_ptr<FD_preferences_formats> dialog_;
+ };
///
- FD_form_interface * build_interface();
+ friend class Formats;
+
///
- FD_form_language * build_language();
+ class InputsMisc {
+ public:
+ ///
+ InputsMisc(FormPreferences & p);
+ ///
+ FD_preferences_inputs_misc const * dialog();
+ ///
+ void apply(LyXRC & rc) const;
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ void update(LyXRC const & rc);
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ boost::scoped_ptr<FD_preferences_inputs_misc> dialog_;
+ };
+ ///
+ friend class InputsMisc;
+
///
- FD_form_lnf_misc * build_lnf_misc();
+ class Interface {
+ public:
+ ///
+ Interface(FormPreferences & p);
+ ///
+ FD_preferences_interface const * dialog();
+ ///
+ void apply(LyXRC & rc) const;
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ bool input(FL_OBJECT const * const);
+ ///
+ void update(LyXRC const & rc);
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ boost::scoped_ptr<FD_preferences_interface> dialog_;
+ };
+ ///
+ friend class Interface;
+
///
- FD_form_outputs_misc * build_outputs_misc();
+ class Language {
+ public:
+ ///
+ Language(FormPreferences & p);
+ ///
+ FD_preferences_language const * dialog();
+ ///
+ void apply(LyXRC & rc); // not const because calls update()
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ bool input(FL_OBJECT const * const);
+ ///
+ void update(LyXRC const & rc);
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ boost::scoped_ptr<FD_preferences_language> dialog_;
+ ///
+ std::vector<string> lang_;
+ };
+ ///
+ friend class Language;
+
///
- FD_form_paths * build_paths();
+ class LnFmisc {
+ public:
+ ///
+ LnFmisc(FormPreferences & p);
+ ///
+ FD_preferences_lnf_misc const * dialog();
+ ///
+ void apply(LyXRC & rc) const;
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ void update(LyXRC const & rc);
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ boost::scoped_ptr<FD_preferences_lnf_misc> dialog_;
+ };
+ ///
+ friend class LnFmisc;
+
+ class Identity {
+ public:
+ ///
+ Identity(FormPreferences & p);
+ ///
+ FD_preferences_identity const * dialog();
+ ///
+ void apply(LyXRC & rc) const;
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ void update(LyXRC const & rc);
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ boost::scoped_ptr<FD_preferences_identity> dialog_;
+ };
+ friend class Identity;
+
///
- FD_form_printer * build_printer();
+ class OutputsMisc {
+ public:
+ ///
+ OutputsMisc(FormPreferences & p);
+ ///
+ FD_preferences_outputs_misc const * dialog();
+ ///
+ void apply(LyXRC & rc) const;
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ void update(LyXRC const & rc);
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ boost::scoped_ptr<FD_preferences_outputs_misc> dialog_;
+ };
+ ///
+ friend class OutputsMisc;
+
///
- FD_form_screen_fonts * build_screen_fonts();
+ class Paths {
+ public:
+ ///
+ Paths(FormPreferences & p);
+ ///
+ FD_preferences_paths const * dialog();
+ ///
+ void apply(LyXRC & rc);
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ bool input(FL_OBJECT const * const);
+ ///
+ void update(LyXRC const & rc);
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ boost::scoped_ptr<FD_preferences_paths> dialog_;
+ };
+ ///
+ friend class Paths;
+
///
- FD_form_spellchecker * build_spellchecker();
+ class Printer {
+ public:
+ ///
+ Printer(FormPreferences & p);
+ ///
+ FD_preferences_printer const * dialog();
+ ///
+ void apply(LyXRC & rc) const;
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ void update(LyXRC const & rc);
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ boost::scoped_ptr<FD_preferences_printer> dialog_;
+ };
+ ///
+ friend class Printer;
- /// Real GUI implementation.
- FD_form_preferences * dialog_;
- /// Converters tabfolder
- FD_form_outer_tab * converters_tab_;
- /// reLyX and other import/input stuff
- FD_form_outer_tab * inputs_tab_;
- /// HCI configuration
- FD_form_outer_tab * look_n_feel_tab_;
- /// Outputs tabfolder
- FD_form_outer_tab * outputs_tab_;
- /// Spellchecker, language stuff, etc
- FD_form_outer_tab * usage_tab_;
///
- FD_form_colors * colors_;
+ class ScreenFonts {
+ public:
+ ///
+ ScreenFonts(FormPreferences & p);
+ ///
+ FD_preferences_screen_fonts const * dialog();
+ ///
+ void apply(LyXRC & rc) const;
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ bool input();
+ ///
+ void update(LyXRC const & rc);
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ boost::scoped_ptr<FD_preferences_screen_fonts> dialog_;
+ };
+ ///
+ friend class ScreenFonts;
+
///
- FD_form_converters * converters_;
+ class SpellOptions {
+ public:
+ ///
+ SpellOptions(FormPreferences & p);
+ ///
+ FD_preferences_spelloptions const * dialog();
+ ///
+ void apply(LyXRC & rc); // not const because calls update()!
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ bool input(FL_OBJECT const * const);
+ ///
+ void update(LyXRC const & rc);
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ boost::scoped_ptr<FD_preferences_spelloptions> dialog_;
+ };
+ ///
+ friend class SpellOptions;
+
+ /** The tab folders.
+ */
+
///
- FD_form_formats * formats_;
+ Colors colors_;
///
- FD_form_inputs_misc * inputs_misc_;
+ Converters converters_;
///
- FD_form_interface * interface_;
+ InputsMisc inputs_misc_;
///
- FD_form_language * language_;
+ Formats formats_;
///
- FD_form_lnf_misc * lnf_misc_;
+ Interface interface_;
///
- FD_form_outputs_misc * outputs_misc_;
+ Language language_;
///
- FD_form_paths * paths_;
+ LnFmisc lnf_misc_;
///
- FD_form_printer * printer_;
+ Identity identity_;
///
- FD_form_screen_fonts * screen_fonts_;
+ OutputsMisc outputs_misc_;
///
- FD_form_spellchecker * spellchecker_;
+ Paths paths_;
///
- Combox * combo_default_lang;
+ Printer printer_;
///
- Combox * combo_kbmap_1;
+ ScreenFonts screen_fonts_;
///
- Combox * combo_kbmap_2;
+ SpellOptions spelloptions_;
- /// A vector of Formats, to be manipulated in the Format browser.
- std::vector<Format> formats_vec;
- /// A vector of Commands, to be manipulated in the Converter browser.
- std::vector<Command> commands_vec;
- /// A vector of RGB colors and associated name.
- static std::vector<X11Color> colorDB;
- /// A vector of xform RGB colors and associated name.
- static std::vector<XFormColor> xformColorDB;
- /** A collection of kmap files.
- First entry is the file name, full path.
- Second entry is the shorthand, as appears in the fl_choice.
- Eg, system_lyxdir/kbd/american2.kmap, american2
- */
- static std::pair<std::vector<string>, std::vector<string> > dirlist;
- ///
- bool warningPosted;
+ /** A couple of helper structs to enable colors to be sorted by name
+ and by color */
+ ///
+ struct SortColorsByName {
+ ///
+ int operator()(NamedColor const & a, NamedColor const & b) const
+ { return (a.getname() < b.getname()); }
+ };
+ ///
+ struct SortColorsByColor {
+ ///
+ SortColorsByColor(RGBColor c) : col(c) {}
+ ///
+ int operator()(RGBColor const &, RGBColor const &) const;
+ ///
+ RGBColor col;
+ };
};
-#endif
+#endif // FORMPREFERENCES_H
projects / lyx.git / blobdiff