#ifndef FORMPREFERENCES_H
#define FORMPREFERENCES_H
-#include "FormBase.h"
-
#ifdef __GNUG_
#pragma interface
#endif
-class LyXView;
+#include <utility> // pair
+#include "FormBase.h"
+#include "Color.h" // NamedColor
+#include "xform_helpers.h" // XformColor
+
+class Combox;
class Dialogs;
-struct FD_form_colours;
+class LyXView;
+class RGBColor;
+struct FD_form_colors;
struct FD_form_converters;
struct FD_form_formats;
struct FD_form_inputs_misc;
struct FD_form_printer;
struct FD_form_screen_fonts;
struct FD_form_spellchecker;
-class Combox;
-class Format;
+
/** This class provides an XForms implementation of the FormPreferences Dialog.
The preferences dialog allows users to set/save their preferences.
///
~FormPreferences();
///
- static void ComboLanguageCB(int, void *, Combox *);
- ///
- static void FeedbackCB(FL_OBJECT *, long);
- ///
- void feedbackPost(FL_OBJECT *, int);
-
- /// helper struct for Colours
- struct RGB {
- int r;
- int g;
- int b;
- RGB() : r(0), g(0), b(0) {}
- RGB(int red, int green, int blue) : r(red), g(green), b(blue) {}
- };
+ static int FeedbackCB(FL_OBJECT *, int,
+ FL_Coord, FL_Coord, int, void *);
private:
+ /// Connect signals etc. Set form's max size.
+ virtual void connect();
+ /// Disconnect signals. Also perform any necessary housekeeping.
+ virtual void disconnect();
+ /** Redraw the form (on receipt of a Signal indicating, for example,
+ that the xform colours have been re-mapped). */
+ virtual void redraw();
/// Update the dialog.
virtual void update();
- ///
+ /// Hide the dialog.
virtual void hide();
- /// OK from dialog
+ /// OK (Save) from dialog
virtual void ok();
/// Apply from dialog
virtual void apply();
virtual bool input(FL_OBJECT *, long);
/// Build the dialog
virtual void build();
- /// control which feedback message is output
- void feedback( FL_OBJECT * );
- ///
+ /// Pointer to the actual instantiation of xform's form.
virtual FL_FORM * form() const;
+ /// control which feedback message is output
+ void feedback(FL_OBJECT *);
- /** Folder specific apply functions.
- */
-
- ///
- void applyColours() const;
- ///
- void applyConverters() const;
- ///
- void applyFormats() const;
- ///
- void applyInputsMisc() const;
- ///
- void applyInterface() const;
- ///
- void applyLanguage() const;
- ///
- 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!
-
- /** Folder specific build functions.
- */
-
- ///
- void buildColours();
- ///
- 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 feedbackColours(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;
-
- /** Folder specific input functions. Not all folders require one.
- */
-
- ///
- bool inputColours(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);
-
- /** Folder specific update functions.
- */
-
- ///
- void updateColours();
- ///
- void updateConverters();
- ///
- void updateFormats();
- ///
- void updateInputsMisc();
- ///
- void updateInterface();
- ///
- void updateLanguage();
- ///
- void updateLnFmisc();
- ///
- void updateOutputsMisc();
- ///
- void updatePaths();
- ///
- void updatePrinter();
- ///
- void updateScreenFonts();
- ///
- void updateSpellChecker();
-
- /** Some helper functions for specific folders.
+ /// Set the preemptive handler for each FL_OBJECT.
+ static void setPreHandler(FL_OBJECT *);
+ /// The preemptive handler for feedback messages.
+ void Feedback(FL_OBJECT *, int);
+ /// Print a warning message and set warning flag.
+ void printWarning( string const & );
+ /** Launch a file dialog and modify input if it returns a new file.
+ For an explanation of the various parameters, see xform_helpers.h.
*/
+ void browse( FL_OBJECT * input,
+ string const & title, string const & pattern,
+ std::pair<string,string> const & dir1,
+ std::pair<string,string> const & dir2 );
- ///
- void LanguagesAdd( Combox & ) const;
- ///
- bool ColoursLoadBrowser( string const & );
- ///
- int ColoursSearchEntry(RGB const & ) const;
- ///
- void ColoursUpdateBrowser( int );
- ///
- void ColoursUpdateRGB();
-
- ///
- bool WriteableDir( string const & ) const;
- ///
- bool ReadableDir( string const & ) const;
- ///
- bool WriteableFile( string const &, string const & = string() ) const;
-
- /// The timer post handler.
- void setPostHandler( FL_OBJECT * ) const;
-
/// Type definitions from the fdesign produced header file.
FD_form_preferences * build_preferences();
///
FD_form_outer_tab * build_outer_tab();
///
- FD_form_colours * build_colours();
+ FD_form_colors * build_colors();
///
FD_form_converters * build_converters();
///
/// Outputs tabfolder
FD_form_outer_tab * outputs_tab_;
/// Spellchecker, language stuff, etc
- FD_form_outer_tab * usage_tab_;
+ FD_form_outer_tab * lang_opts_tab_;
+
+ /** Flag whether a warning has been posted to the text window.
+ If so, don't redraw the window when the mouse leaves an object. */
+ bool warningPosted;
+
+ /** Each tab folder is encapsulated in its own class.
+ */
+
+ class Colors {
+ public:
+ ///
+ enum GuiColors {
+ GUI_COLOR_CHOICE = FL_FREE_COL1,
+ GUI_COLOR_HUE_DIAL = FL_FREE_COL2,
+ GUI_COLOR_CURSOR = FL_FREE_COL3
+ };
+ ///
+ Colors( FormPreferences & p ) : parent_(p), dialog_(0) {}
+ ///
+ ~Colors();
+ ///
+ FD_form_colors const * dialog() { return dialog_; }
+ ///
+ void apply(); // not const as modifies modifiedXformPrefs.
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ void input(FL_OBJECT const * const);
+ ///
+ void update() { LoadBrowserLyX(); }
+
+ /// Flag whether Xforms colors have changed since last file save
+ bool modifiedXformPrefs;
+
+ private:
+ ///
+ void AdjustVal( int, int, double ) const;
+ ///
+ void InputBrowserLyX() const;
+ ///
+ void InputHSV();
+ ///
+ void InputRGB();
+ ///
+ void LoadBrowserLyX();
+ ///
+ void Modify();
+ ///
+ void SwitchColorSpace() const;
+ ///
+ string const X11hexname(RGBColor const &) const;
+
+ ///
+ FormPreferences & parent_;
+ ///
+ FD_form_colors * dialog_;
+
+ /// A vector of LyX LColor GUI name and associated RGB color.
+ std::vector<NamedColor> lyxColorDB;
+ /// A vector of xform color ID, RGB colors and associated name.
+ std::vector<XformColor> xformColorDB;
+ };
+ ///
+ friend class Colors;
+
+ ///
+ class Converters {
+ public:
+ ///
+ Converters( FormPreferences & p ) : parent_(p), dialog_(0) {}
+ ///
+ ~Converters();
+ ///
+ FD_form_converters const * dialog() { return 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;
+
+ private:
+ ///
+ bool Add();
+ ///
+ bool Browser();
+ ///
+ bool Delete();
+ ///
+ bool Input();
+ ///
+ string const GetFrom() const;
+ ///
+ string const GetTo() const;
+
+ ///
+ FormPreferences & parent_;
+ ///
+ FD_form_converters * dialog_;
+ };
+ ///
+ friend class Converters;
+
///
- FD_form_colours * colours_;
+ class Formats {
+ public:
+ ///
+ Formats( FormPreferences & p ) : parent_(p), dialog_(0) {}
+ ///
+ ~Formats();
+ ///
+ FD_form_formats const * dialog() { return 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 Delete();
+ ///
+ bool Input();
+
+ ///
+ FormPreferences & parent_;
+ ///
+ FD_form_formats * dialog_;
+ };
+ ///
+ friend class Formats;
+
///
- FD_form_converters * converters_;
+ class InputsMisc {
+ public:
+ ///
+ InputsMisc( FormPreferences & p ) : parent_(p), dialog_(0) {}
+ ///
+ ~InputsMisc();
+ ///
+ FD_form_inputs_misc const * dialog() { return dialog_; }
+ ///
+ void apply() const;
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ void update();
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ FD_form_inputs_misc * dialog_;
+ };
///
- FD_form_formats * formats_;
+ friend class InputsMisc;
+
///
- FD_form_inputs_misc * inputs_misc_;
+ class Interface {
+ public:
+ ///
+ Interface( FormPreferences & p ) : parent_(p), dialog_(0) {}
+ ///
+ ~Interface();
+ ///
+ FD_form_interface const * dialog() { return dialog_; }
+ ///
+ void apply() const;
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ bool input( FL_OBJECT const * const );
+ ///
+ void update();
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ FD_form_interface * dialog_;
+ };
///
- FD_form_interface * interface_;
+ friend class Interface;
+
///
- FD_form_language * language_;
+ class Language {
+ public:
+ ///
+ Language( FormPreferences & p )
+ : parent_(p), dialog_(0), combo_default_lang(0) {}
+ ///
+ ~Language();
+ ///
+ FD_form_language const * dialog() { return dialog_; }
+ ///
+ void apply(); // not const because calls update()
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ bool input( FL_OBJECT const * const );
+ ///
+ void update();
+ ///
+ static void ComboCB(int, void *, Combox *);
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ FD_form_language * dialog_;
+ ///
+ Combox * combo_default_lang;
+ };
///
- FD_form_lnf_misc * lnf_misc_;
+ friend class Language;
+
///
- FD_form_outputs_misc * outputs_misc_;
+ class LnFmisc {
+ public:
+ ///
+ LnFmisc( FormPreferences & p ) : parent_(p), dialog_(0) {}
+ ///
+ ~LnFmisc();
+ ///
+ FD_form_lnf_misc const * dialog() { return dialog_; }
+ ///
+ void apply() const;
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ void update();
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ FD_form_lnf_misc * dialog_;
+ };
///
- FD_form_paths * paths_;
+ friend class LnFmisc;
+
///
- FD_form_printer * printer_;
+ class OutputsMisc {
+ public:
+ ///
+ OutputsMisc( FormPreferences & p ) : parent_(p), dialog_(0) {}
+ ///
+ ~OutputsMisc();
+ ///
+ FD_form_outputs_misc const * dialog() { return dialog_; }
+ ///
+ void apply() const;
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ void update();
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ FD_form_outputs_misc * dialog_;
+ };
///
- FD_form_screen_fonts * screen_fonts_;
+ friend class OutputsMisc;
+
///
- FD_form_spellchecker * spellchecker_;
+ class Paths {
+ public:
+ ///
+ Paths( FormPreferences & p ) : parent_(p), dialog_(0) {}
+ ///
+ ~Paths();
+ ///
+ FD_form_paths const * dialog() { return dialog_; }
+ ///
+ void apply();
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ bool input(FL_OBJECT const * const);
+ ///
+ void update();
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ FD_form_paths * dialog_;
+ };
///
- Combox * combo_default_lang;
+ friend class Paths;
+
///
- Combox * combo_kbmap_1;
+ class Printer {
+ public:
+ ///
+ Printer( FormPreferences & p ) : parent_(p), dialog_(0) {}
+ ///
+ ~Printer();
+ ///
+ FD_form_printer const * dialog() { return dialog_; }
+ ///
+ void apply() const;
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ void update();
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ FD_form_printer * dialog_;
+ };
///
- Combox * combo_kbmap_2;
+ friend class Printer;
+
///
- FL_OBJECT * feedbackObj;
+ class ScreenFonts {
+ public:
+ ///
+ ScreenFonts( FormPreferences & p ) : parent_(p), dialog_(0) {}
+ ///
+ ~ScreenFonts();
+ ///
+ FD_form_screen_fonts const * dialog() { return dialog_; }
+ ///
+ void apply() const;
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ bool input();
+ ///
+ void update();
+
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ FD_form_screen_fonts * dialog_;
+ };
///
- std::vector<Format> formats_vec;
+ friend class ScreenFonts;
-};
+ ///
+ class SpellChecker {
+ public:
+ ///
+ SpellChecker( FormPreferences & p ) : parent_(p), dialog_(0) {}
+ ///
+ ~SpellChecker();
+ ///
+ FD_form_spellchecker const * dialog() { return dialog_; }
+ ///
+ void apply(); // not const because calls update()!
+ ///
+ void build();
+ ///
+ string const feedback(FL_OBJECT const * const) const;
+ ///
+ bool input(FL_OBJECT const * const);
+ ///
+ void update();
+ private:
+ ///
+ FormPreferences & parent_;
+ ///
+ FD_form_spellchecker * dialog_;
+ };
+ ///
+ friend class SpellChecker;
-inline
-bool operator==(FormPreferences::RGB const & c1,
- FormPreferences::RGB const & c2)
-{
- return (c1.r == c2.r && c1.g == c2.g && c1.b == c2.b);
-}
+ /** The tab folders.
+ */
+
+ ///
+ Colors colors_;
+ ///
+ Converters converters_;
+ ///
+ InputsMisc inputs_misc_;
+ ///
+ Formats formats_;
+ ///
+ Interface interface_;
+ ///
+ Language language_;
+ ///
+ LnFmisc lnf_misc_;
+ ///
+ OutputsMisc outputs_misc_;
+ ///
+ Paths paths_;
+ ///
+ Printer printer_;
+ ///
+ ScreenFonts screen_fonts_;
+ ///
+ SpellChecker spellchecker_;
+ /** 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;
+ };
-inline
-bool operator!=(FormPreferences::RGB const & c1,
- FormPreferences::RGB const & c2)
-{
- return !(c1 == c2);
-}
+};
#endif