From 3f40e63e1b9fa629197196b1a6a972f8680eaef5 Mon Sep 17 00:00:00 2001 From: Vincent van Ravesteijn Date: Mon, 1 Feb 2010 15:58:29 +0000 Subject: [PATCH] Finally add some comments to the currentBufferView() and documentBufferView() functions. Text from Tommaso (adjusted to my own taste) from the devel-list. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@33311 a592a061-630c-0410-9148-cb99ea01b6c8 --- src/frontends/LyXView.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/frontends/LyXView.h b/src/frontends/LyXView.h index 8735903202..49d3619ffd 100644 --- a/src/frontends/LyXView.h +++ b/src/frontends/LyXView.h @@ -50,9 +50,16 @@ public: /// \name Generic accessor functions //@{ + /// The current BufferView refers to the BufferView that has the focus, + /// including for example the one that is created when you use the + /// advanced search and replace pane. /// \return the currently selected buffer view. virtual BufferView * currentBufferView() = 0; virtual BufferView const * currentBufferView() const = 0; + + /// The document BufferView always refers to the view's main document + /// BufferView. So, even if the BufferView in e.g., the advanced + /// search and replace pane has the focus. /// \return the current document buffer view. virtual BufferView * documentBufferView() = 0; virtual BufferView const * documentBufferView() const = 0; -- 2.39.2