src/Utils/MiscUI/MenuButton.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2016-2017, 2020, 2023 - TortoiseGit
   4 // Copyright (C) 2011, 2016 - Sven Strickroth <email@cs-ware.de>
   5
   6 //based on:
   7 // Copyright (C) 2003-2007 - TortoiseSVN
   8
   9 // This program is free software; you can redistribute it and/or
  10 // modify it under the terms of the GNU General Public License
  11 // as published by the Free Software Foundation; either version 2
  12 // of the License, or (at your option) any later version.
  13
  14 // This program is distributed in the hope that it will be useful,
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 // GNU General Public License for more details.
  18
  19 // You should have received a copy of the GNU General Public License
  20 // along with this program; if not, write to the Free Software Foundation,
  21 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22 //
  23 #pragma once
  24 #include "IconMenu.h"
  25 #include "ThemeControls.h"
  26
  27 /**
  28  * \ingroup Utils
  29  * A button control with a menu to choose from different
  30  * actions. Clicking on the left "button" part is the same
  31  * as with a normal button, clicking on the right "arrow"
  32  * part will bring up a menu where the user can choose what
  33  * action the button should do.
  34  */
  35 class CMenuButton : public CThemeMFCMenuButton
  36 {
  37 public:
  38         DECLARE_DYNCREATE(CMenuButton);
  39
  40         CMenuButton();
  41         virtual ~CMenuButton();
  42
  43         /**
  44          * Inserts a text to be shown in the button menu.
  45          * The text is inserted at the end of the menu string list.
  46          * \return the index of the inserted item. This index is
  47          * returned in GetCurrentEntry().
  48          */
  49         INT_PTR AddEntry(const CString& sEntry, UINT uIcon = 0U);
  50
  51         /**
  52          * Inserts an array of strings to be shown in the
  53          * button menu. The strings are inserted at the end
  54          * of the menu string list.
  55          * \return the index of the first inserted item. This index
  56          * is returned in GetCurrentEntry().
  57          */
  58         INT_PTR AddEntries(const CStringArray& sEntries);
  59
  60         /**
  61          * Returns the currently shown entry index of the button.
  62          */
  63         INT_PTR GetCurrentEntry() const { return (m_nMenuResult == 0) ? m_nDefault - 1 : m_nMenuResult - 1; }
  64
  65         /**
  66          * Sets which of the menu strings should be shown in the
  67          * button and be active.
  68          * \return true if successful
  69          */
  70         bool    SetCurrentEntry(INT_PTR entry);
  71
  72         /**
  73          * Determines if the button control is drawn with the XP
  74          * themes or without. The default is \a true, which means
  75          * the control is drawn with theming support if the underlying
  76          * OS has it enabled and supports it.
  77          */
  78         void    RemoveAll();
  79
  80         bool    m_bMarkDefault = true;
  81
  82         /** Don't show text on Button */
  83         bool    m_bShowCurrentItem = true;
  84
  85         bool    m_bAlwaysShowArrow = false;
  86
  87 protected:
  88         BOOL PreTranslateMessage(MSG* pMsg) override;
  89
  90         BOOL IsPressed() const override;
  91
  92         afx_msg void OnDraw(CDC* pDC, const CRect& rect, UINT uiState) override;
  93         afx_msg void OnLButtonDown(UINT nFlags, CPoint point);
  94         afx_msg void OnSysColorChange();
  95         afx_msg LRESULT OnThemeChanged();
  96
  97         afx_msg BOOL OnClicked();
  98         afx_msg void OnDestroy();
  99
 100         CIconMenu       m_btnMenu;
 101         INT_PTR m_nDefault = 0;
 102
 103         DECLARE_MESSAGE_MAP()
 104
 105         CStringArray m_sEntries;
 106
 107         CFont m_Font;
 108         void FixFont();
 109 };