AutocompletePopup.h

Go to the documentation of this file.

// -*- mode: c++; c-file-style: "linux"; c-basic-offset: 2; indent-tabs-mode: nil -*-
//
//  Copyright (C) 2009-2015 Andrej Vodopivec <andrej.vodopivec@gmail.com>
//  Copyright (C) 2015-2016 Gunter Königsmann     <wxMaxima@physikbuch.de>
//
//  This program 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 2 of the License, or
//  (at your option) any later version.
//
//  This program 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 this program; if not, write to the Free Software
//  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
//  SPDX-License-Identifier: GPL-2.0+
 
#ifndef AUTOCOMPLETEPOPUP_H
#define AUTOCOMPLETEPOPUP_H
 
#include "precomp.h"
#include "Autocomplete.h"
#include "cells/EditorCell.h"
#include <wx/combo.h>
#include <wx/listctrl.h>
#include <vector>
 
class AutocompletePopup final : public wxListView, public wxComboPopup
{
  // Return pointer to the created control
  wxWindow *GetControl() override { return this; }
 
  // Translate string into a list selection
  void SetStringValue(const wxString& s) override
    {
      int n = wxListView::FindItem(-1, s);
      if (n >= 0 && n < wxListView::GetItemCount() )
        wxListView::Select(n);
    }
  // Get list selection as a string
  wxString GetStringValue() const override
    { return (m_value >= 0) ? wxListView::GetItemText(m_value) : wxString(); }
 
private:
  struct DonePtr { AutocompletePopup*& observer; ~DonePtr() { observer = nullptr; } };
  int m_value = -1; // current item index
  wxString m_partial;
 
  wxWindow *m_parent = {};
  const DonePtr m_doneptr;
  std::vector<wxString> m_completions;
  AutoComplete *m_autocomplete = {};
  CellPtr<EditorCell> m_editor;
  AutoComplete::autoCompletionType m_type;
  wxString m_fileBaseDir;
 
  wxPoint m_position;
  wxRect m_screenRect;
 
  bool CompletesFiles() const { return AutoComplete::CompletesFiles(m_type); }
  static bool IsDirectoryCompletion(const wxString &completion) {
    return completion.EndsWith(wxS("/\""));
  }
  bool DescendIntoDirectory(const wxString &completion);
 
public:
  void SetPosition(wxPoint pos){m_position = pos;}
  bool Create(wxWindow* parent) override;
  virtual ~AutocompletePopup();
  void OnChar(wxKeyEvent &event);
  void OnKeyDown(wxKeyEvent &event);
 
  AutocompletePopup(wxWindow *parent, EditorCell *editor, AutoComplete *autocomplete,
                    AutoComplete::autoCompletionType type, AutocompletePopup **doneptr,
                    const wxString &fileBaseDir = {});
 
  void UpdateResults(bool allowAutoFinish = true);
 
  void OnClick(wxMouseEvent &event);
};
 
#endif // AUTOCOMPLETEPOPUP_H