]> git.lyx.org Git - lyx.git/blobdiff - src/lyxfind.h
remove noload/don't typeset
[lyx.git] / src / lyxfind.h
index 37509ef0a2ca4503ddc22742bad3087f03387a2c..f86b8dec851bc2c29a3823f4aa6d202e38adc0db 100644 (file)
@@ -1,3 +1,4 @@
+// -*- C++ -*-
 #ifndef LYXFIND_H
 #define LYXFIND_H
 
@@ -6,27 +7,47 @@
 #endif
 
 #include "LString.h"
-#include "lyxparagraph.h"
 
 class BufferView;
-
-int LyXReplace(BufferView * bv, string const &, string const &,
-              bool const &, bool const &, bool const &, bool const & = false);
-
-bool LyXFind(BufferView * bv, string const &, bool const &, bool const &,
-            bool const &);
-
-/// returns true if the specified string is at the specified  position
-bool IsStringInText(LyXParagraph * par, LyXParagraph::size_type pos,
-                   string const & str, bool const & = true,
-                   bool const & = false);
-
-/// if the string is found: return true and set the cursor to the new position
-bool SearchForward(BufferView *, string const & str, bool const & = true, 
-                  bool const & = false);
-///
-bool SearchBackward(BufferView *, string const & str, bool const & = true, 
-                   bool const & = false);
-
-
+class LyXText;
+
+namespace lyxfind {
+
+enum SearchResult {
+       //
+       SR_NOT_FOUND = 0,
+       //
+       SR_FOUND,
+       //
+       SR_FOUND_NOUPDATE
+};
+
+
+int LyXReplace(BufferView * bv,
+              string const &, string const &,
+              bool, bool = true, bool = false,
+              bool = false, bool = false);
+
+/**
+ * This function is called as a general interface to find some
+ * text from the actual cursor position in whatever direction
+ * we want to go. This does also update the screen.
+ */
+bool LyXFind(BufferView *,
+            string const & searchstr, bool forward,
+            bool casesens = true, bool matchwrd = false);
+
+/**
+ * This function does search from the cursor position inside the
+ * passed LyXText parameter and regards this LyXText as the root
+ * LyXText. It will NOT update any screen stuff. It will however
+ * set the cursor to the new position inside LyXText, before
+ * returning to the calling function.
+ */
+
+SearchResult LyXFind(BufferView *, LyXText * text,
+                    string const & searchstr, bool forward,
+                    bool casesens = true, bool matchwrd = false);
+
+} // end namespace LyXFind
 #endif