view libgui/src/m-editor/octave-qscintilla.cc @ 16731:01d523d5f796

add help for word at mouse or text cursor to the editors context menu * octave-qscintilla.h: new class derived from qsciscintilla to get acces to the editors context menu * octave-qscxintilla.cc(contextMenuEvent): create standard context menu and add entry for calling help on current word at cursor (contextmenu_help): handler for the new menu entry * libgui/src/module.mk: add new files octave_qscintilla.cc/.h * file-editor-tab.cc(constructor): _edit_area is of class octave_qscintilla, connect the signal of this class for command execution (execute_command_in_terminal): slot for signal connected in contructor * file-editor-tab.h: new slot for executing a command in terminal, _edit_area is of new class octave_qscintilla
author Torsten <ttl@justmail.de>
date Fri, 07 Jun 2013 23:13:48 +0200
parents
children 2723d1144f11
line wrap: on
line source

/*

Copyright (C) 2013 Torsten <ttl@justmail.de>

This file is part of Octave.

Octave is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3 of the License, or (at your
option) any later version.

Octave is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with Octave; see the file COPYING.  If not, see
<http://www.gnu.org/licenses/>.

*/

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#ifdef HAVE_QSCINTILLA

#include "octave-qscintilla.h"
#include "file-editor-tab.h"

octave_qscintilla::octave_qscintilla (QWidget *p)
    : QsciScintilla (p)
{ }

octave_qscintilla::~octave_qscintilla ()
{ }


// context menu requested
void
octave_qscintilla::contextMenuEvent (QContextMenuEvent *e)
{
  QMenu *context_menu = createStandardContextMenu ( );  // standard menu

  context_menu->addSeparator ();   // separator before custom entries

  // help menu: get the position of the mouse or the text cursor
  _word_at_cursor = "";
  QPoint global_pos = e->globalPos ();            // global mouse position

  if (e->reason () == QContextMenuEvent::Mouse)   // context menu by mouse
    _word_at_cursor = wordAtPoint (e->pos ());
  else
    { // context menu by keyboard or other: get point of text cursor
      long position = SendScintilla (QsciScintillaBase::SCI_GETCURRENTPOS);
      long point_x  = SendScintilla
                        (QsciScintillaBase::SCI_POINTXFROMPOSITION,0,position);
      long point_y  = SendScintilla
                        (QsciScintillaBase::SCI_POINTYFROMPOSITION,0,position);
      QPoint local_pos = QPoint (point_x,point_y);  // local position of cursor
      global_pos = mapToGlobal (local_pos); // global position of cursor
      QRect editor_rect = geometry ();      // get editor rect and map to global
      editor_rect.moveTopLeft(parentWidget()->mapToGlobal(editor_rect.topLeft()));
      if (editor_rect.contains (global_pos))  // is cursor within editor?
        _word_at_cursor = wordAtPoint (local_pos);
      else
        global_pos = editor_rect.topLeft ();
    }
  // finally create the menu entry if a word at cursor was found
  if (!_word_at_cursor.isEmpty ())
    context_menu->addAction (tr ("help") + " " + _word_at_cursor,
                             this, SLOT (contextmenu_help (bool)));

  context_menu->exec (global_pos);
}


// handle the menu entry for calling help
void
octave_qscintilla::contextmenu_help (bool)
{
  QString command = "help " + _word_at_cursor;
  emit execute_command_in_terminal_signal (command);
}

#endif