// TortoiseSVN - a Windows shell extension for easy version control

// Copyright (C) 2003-2008, 2010-2012, 2021 - TortoioseSVN

// 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,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
#pragma once

/**
 * \ingroup Utils
 * Extends the CComboBoxEx class with a history of entered
 * values. An example of such a combobox is the Start/Run
 * dialog which lists the programs you used last in a combobox.
 * To use this class do the following:
 * -# add both files HistoryCombo.h and HistoryCombo.cpp to your project.
 * -# add a ComboBoxEx to your dialog
 * -# create a variable for the ComboBox of type control
 * -# change the type of the created variable from CComboBoxEx to
 *    CHistoryCombo
 * -# in your OnInitDialog() call SetURLHistory(TRUE) if your ComboBox
 *    contains URLs
 * -# in your OnInitDialog() call the LoadHistory() method
 * -# in your OnOK() or somewhere similar call the SaveHistory() method
 *
 * thats it.
 */
class CHistoryCombo : public CComboBoxEx
{
    // Construction
public:
    CHistoryCombo(BOOL bAllowSortStyle = FALSE);
    ~CHistoryCombo() override;

    // Operations
public:
    /**
     * Adds the string \a str to both the combobox and the history.
     * If \a pos is specified, insert the string at the specified
     * position, otherwise add it to the end of the list.
     */
    int AddString(CString str, INT_PTR pos = -1);

protected:
    DECLARE_MESSAGE_MAP()
    BOOL PreCreateWindow(CREATESTRUCT& cs) override;
    BOOL PreTranslateMessage(MSG* pMsg) override;
    void PreSubclassWindow() override;

    afx_msg void OnMouseMove(UINT nFlags, CPoint point);
    afx_msg void OnTimer(UINT_PTR nIDEvent);
    afx_msg int  OnCreate(LPCREATESTRUCT lpCreateStruct);

    void CreateToolTip();

    // Implementation
public:
    /**
     * Clears the history in the registry/inifile and the ComboBox.
     * \param bDeleteRegistryEntries if this value is true then the registry key
     * itself is deleted.
     */
    void ClearHistory(BOOL bDeleteRegistryEntries = TRUE);
    /**
     * When \a bURLHistory is TRUE, treat the combo box entries
     * as URLs. This activates Shell URL auto completion and
     * the display of special icons in front of the combobox
     * entries. Default is FALSE.
     */
    void SetURLHistory(bool bURLHistory, bool bAutoComplete);
    /**
     * When \a bPathHistory is TRUE, treat the combo box entries
     * as Paths. This activates Shell Path auto completion and
     * the display of special icons in front of the combobox
     * entries. Default is FALSE.
     */
    void SetPathHistory(BOOL bPathHistory);
    /**
     * Sets the maximum numbers of entries in the history list.
     * If the history is larger as \em nMaxItems then the last
     * items in the history are deleted.
     */
    void SetMaxHistoryItems(int nMaxItems);
    /**
     * Saves the history to the registry/inifile.
     * \remark if you haven't called LoadHistory() before this method
     * does nothing!
     */
    void SaveHistory();
    /**
     * Loads the history from the registry/inifile and fills in the
     * ComboBox.
     * \param lpszSection a section name where to put the entries, e.g. "lastloadedfiles"
     * \param lpszKeyPrefix a prefix to use for the history entries in registry/inifiles. E.g. "file" or "entry"
     */
    CString LoadHistory(LPCWSTR lpszSection, LPCWSTR lpszKeyPrefix);

    /**
     * Returns the string in the combobox which is either selected or the user has entered.
     */
    CString GetString() const;

    /**
     * Returns the string in the combobox which is shown in the edit control.
     */
    CString GetWindowString() const;

    /**
     * Disables trimming of strings in the combobox. Useful if the combo box is
     * used e.g. for searching.
     */
    void DisableTrimming() { m_bTrim = false; }

protected:
    /**
     * Will be called whenever the return key is pressed while the
     * history combo has the input focus. A derived class may implement
     * a special behavior for the return key by overriding this method.
     * It must return true to prevent the default processing for the
     * return key. The default implementation returns false.
     */
    virtual bool OnReturnKeyPressed() { return false; }

    /**
     * Removes the selected item from the combo box and updates
     * the registry settings. Returns TRUE if successful.
     */
    BOOL RemoveSelectedItem();
    void SetAutoComplete(DWORD flags) const;
    void SetStylesAndImageList();

protected:
    CStringArray m_arEntries;
    CString      m_sSection;
    CString      m_sKeyPrefix;
    int          m_nMaxHistoryItems;
    BOOL         m_bAllowSortStyle;
    BOOL         m_bURLHistory;
    BOOL         m_bPathHistory;
    HWND         m_hWndToolTip;
    TOOLINFO     m_toolInfo;
    CString      m_toolText;
    BOOL         m_ttShown;
    BOOL         m_bDyn;
    BOOL         m_bTrim;
};