]> git.lyx.org Git - lyx.git/blobdiff - src/bufferview_funcs.h
remove mention of lyxrc from the splash
[lyx.git] / src / bufferview_funcs.h
index ad1b174c5d5931deaf9115e3366794f1a301af56..c0bade96251b9b9b6ae2a7a553f0b9fe90b63234 100644 (file)
@@ -1,75 +1,90 @@
 // -*- C++ -*-
-/* This file is part of
- * ====================================================== 
- * 
- *           LyX, The Document Processor
- *        
- *           Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2000 The LyX Team.
+/**
+ * \file bufferview_funcs.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- * ====================================================== */
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ * \author Angus Leeming
+ *
+ * Full author contact details are available in file CREDITS
+ */
 
 #ifndef BUFFERVIEW_FUNCS_H
 #define BUFFERVIEW_FUNCS_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "LString.h"
 
 class BufferView;
 class LyXFont;
 class LyXText;
 
-#ifndef NEW_INSETS
-///
-extern void Foot(BufferView *);
-#endif
-///
-extern void Emph(BufferView *);
-///
-extern void Bold(BufferView *);
-///
-extern void Noun(BufferView *);
-#ifndef NEW_INSETS
-///
-extern void Margin(BufferView *);
-#endif
-///
-extern void Figure();
-///
-extern void Table();
-///
-extern void Lang(BufferView *, string const &);
+namespace bv_funcs {
+
+/** Set \param data using \param font and \param toggle.
+ *  If successful, returns true.
+ */
+bool font2string(LyXFont const & font, bool toggle, string & data);
+/** Set \param font and \param toggle using \param data.
+ *  If successful, returns true.
+ */
+bool string2font(string const & data, LyXFont & font, bool & toggle);
+/** Returns the current freefont, encoded as a string to be passed to the
+ *  frontends.
+ */
+string const freefont2string();
+/** Set the freefont using the contents of \param data dispatched from
+ *  the frontends and apply it at the current cursor location.
+ */
+void update_and_apply_freefont(BufferView * bv, string const & data);
+/** Apply the contents of freefont at the current cursor location.
+ */
+void apply_freefont(BufferView * bv);
+
+/// what type of depth change to make
+enum DEPTH_CHANGE {
+       INC_DEPTH,
+       DEC_DEPTH
+};
+
+/**
+ * Increase or decrease the nesting depth of the selected paragraph(s)
+ * if test_only, don't change any depths. Returns whether something
+ * (would have) changed
+ */
+extern bool changeDepth(BufferView *, LyXText *, DEPTH_CHANGE, bool test_only);
+
 ///
-extern void Number(BufferView *);
-#ifndef NEW_INSETS
+extern void emph(BufferView *);
 ///
-extern void Melt(BufferView *);
-#endif
+extern void bold(BufferView *);
 ///
-extern void Tex(BufferView *);
+extern void noun(BufferView *);
 ///
-extern void changeDepth(BufferView *, LyXText *, int);
+extern void lang(BufferView *, string const &);
 ///
-extern void ProhibitInput(BufferView *);
+extern void number(BufferView *);
 ///
-extern void AllowInput(BufferView *);
+extern void tex(BufferView *);
 ///
-extern void Code(BufferView *);
+extern void code(BufferView *);
 ///
-extern void Sans(BufferView *);
+extern void sans(BufferView *);
 ///
-extern void Roman(BufferView *);
+extern void roman(BufferView *);
 ///
-extern void StyleReset(BufferView *);
+extern void styleReset(BufferView *);
 ///
-extern void Underline(BufferView *);
+extern void underline(BufferView *);
 ///
-extern void FontSize(BufferView *, string const &);
-/// Returns the current font and depth as a message. 
-extern string const CurrentState(BufferView *);
+extern void fontSize(BufferView *, string const &);
+/// Returns the current font and depth as a message.
+extern string const currentState(BufferView *);
 ///
-extern void ToggleAndShow(BufferView *, LyXFont const &, bool toggleall=true);
+extern void toggleAndShow(BufferView *, LyXFont const &,
+                         bool toggleall = true);
+
+}; // namespace bv_funcs
+
 #endif