vcl/source/control/menubtn.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <vcl/dockwin.hxx>
  21 #include <vcl/event.hxx>
  22 #include <vcl/toolkit/floatwin.hxx>
  23 #include <vcl/menu.hxx>
  24 #include <vcl/timer.hxx>
  25 #include <vcl/toolkit/menubtn.hxx>
  26 #include <vcl/settings.hxx>
  27 #include <vcl/uitest/uiobject.hxx>
  28 #include <vcl/uitest/logger.hxx>
  29 #include <vcl/uitest/eventdescription.hxx>
  30 #include <menutogglebutton.hxx>
  31 #include <tools/json_writer.hxx>
  32
  33 namespace
  34 {
  35 void collectUIInformation( const OUString& aID, const OUString& aevent , const OUString& akey , const OUString& avalue)
  36 {
  37     EventDescription aDescription;
  38     aDescription.aID = aID;
  39     aDescription.aParameters = {{ akey ,  avalue}};
  40     aDescription.aAction = aevent;
  41     aDescription.aParent = "MainWindow";
  42     aDescription.aKeyWord = "MenuButton";
  43     UITestLogger::getInstance().logEvent(aDescription);
  44 }
  45 }
  46
  47 void MenuButton::ImplInit( vcl::Window* pParent, WinBits nStyle )
  48 {
  49     if ( !(nStyle & WB_NOTABSTOP) )
  50         nStyle |= WB_TABSTOP;
  51
  52     PushButton::ImplInit( pParent, nStyle );
  53     EnableRTL( AllSettings::GetLayoutRTL() );
  54 }
  55
  56 void MenuButton::ExecuteMenu()
  57 {
  58     mbStartingMenu = true;
  59
  60     Activate();
  61
  62     if (!mpMenu && !mpFloatingWindow)
  63     {
  64         mbStartingMenu = false;
  65         return;
  66     }
  67
  68     Size aSize = GetSizePixel();
  69     SetPressed( true );
  70     EndSelection();
  71     if (mpMenu)
  72     {
  73         Point aPos(0, 1);
  74         tools::Rectangle aRect(aPos, aSize );
  75         mpMenu->Execute(this, aRect, PopupMenuFlags::ExecuteDown);
  76
  77         if (isDisposed())
  78             return;
  79
  80         mnCurItemId = mpMenu->GetCurItemId();
  81         msCurItemIdent = mpMenu->GetCurItemIdent();
  82     }
  83     else
  84     {
  85         Point aPos(GetParent()->OutputToScreenPixel(GetPosPixel()));
  86         tools::Rectangle aRect(aPos, aSize );
  87         FloatWinPopupFlags nFlags = FloatWinPopupFlags::Down | FloatWinPopupFlags::GrabFocus;
  88         if (mpFloatingWindow->GetType() == WindowType::FLOATINGWINDOW)
  89             static_cast<FloatingWindow*>(mpFloatingWindow.get())->StartPopupMode(aRect, nFlags);
  90         else
  91         {
  92             mpFloatingWindow->EnableDocking();
  93             vcl::Window::GetDockingManager()->StartPopupMode(mpFloatingWindow, aRect, nFlags);
  94         }
  95     }
  96
  97     mbStartingMenu = false;
  98
  99     SetPressed(false);
 100     OUString aID = get_id(); // tdf#136678 take a copy if we are destroyed by Select callback
 101     if (mnCurItemId)
 102     {
 103         Select();
 104         mnCurItemId = 0;
 105         msCurItemIdent.clear();
 106     }
 107     collectUIInformation(aID,"OPENLIST","","");
 108 }
 109
 110 void MenuButton::CancelMenu()
 111 {
 112     if (!mpMenu && !mpFloatingWindow)
 113         return;
 114
 115     if (mpMenu)
 116     {
 117         mpMenu->EndExecute();
 118     }
 119     else
 120     {
 121         if (mpFloatingWindow->GetType() == WindowType::FLOATINGWINDOW)
 122             static_cast<FloatingWindow*>(mpFloatingWindow.get())->EndPopupMode();
 123         else
 124             vcl::Window::GetDockingManager()->EndPopupMode(mpFloatingWindow);
 125     }
 126     collectUIInformation(get_id(),"CLOSELIST","","");
 127 }
 128
 129 bool MenuButton::InPopupMode() const
 130 {
 131     if (mbStartingMenu)
 132         return true;
 133
 134     if (!mpMenu && !mpFloatingWindow)
 135         return false;
 136
 137     if (mpMenu)
 138        return PopupMenu::GetActivePopupMenu() == mpMenu;
 139     else
 140     {
 141         if (mpFloatingWindow->GetType() == WindowType::FLOATINGWINDOW)
 142             return static_cast<const FloatingWindow*>(mpFloatingWindow.get())->IsInPopupMode();
 143         else
 144             return vcl::Window::GetDockingManager()->IsInPopupMode(mpFloatingWindow);
 145     }
 146 }
 147
 148 MenuButton::MenuButton( vcl::Window* pParent, WinBits nWinBits )
 149     : PushButton(WindowType::MENUBUTTON)
 150     , mnCurItemId(0)
 151     , mbDelayMenu(false)
 152     , mbStartingMenu(false)
 153 {
 154     mnDDStyle = PushButtonDropdownStyle::MenuButton;
 155     ImplInit(pParent, nWinBits);
 156 }
 157
 158 MenuButton::~MenuButton()
 159 {
 160     disposeOnce();
 161 }
 162
 163 void MenuButton::dispose()
 164 {
 165     mpMenuTimer.reset();
 166     mpFloatingWindow.clear();
 167     mpMenu.clear();
 168     PushButton::dispose();
 169 }
 170
 171 IMPL_LINK_NOARG(MenuButton, ImplMenuTimeoutHdl, Timer *, void)
 172 {
 173     // See if Button Tracking is still active, as it could've been cancelled earlier
 174     if ( IsTracking() )
 175     {
 176         if ( !(GetStyle() & WB_NOPOINTERFOCUS) )
 177             GrabFocus();
 178         ExecuteMenu();
 179     }
 180 }
 181
 182 void MenuButton::MouseButtonDown( const MouseEvent& rMEvt )
 183 {
 184     bool bExecute = true;
 185     if (mbDelayMenu)
 186     {
 187         // If the separated dropdown symbol is not hit, delay the popup execution
 188         if( rMEvt.GetPosPixel().X() <= ImplGetSeparatorX() )
 189         {
 190             if ( !mpMenuTimer )
 191             {
 192                 mpMenuTimer.reset(new Timer("MenuTimer"));
 193                 mpMenuTimer->SetInvokeHandler( LINK( this, MenuButton, ImplMenuTimeoutHdl ) );
 194             }
 195
 196             mpMenuTimer->SetTimeout( MouseSettings::GetActionDelay() );
 197             mpMenuTimer->Start();
 198
 199             PushButton::MouseButtonDown( rMEvt );
 200             bExecute = false;
 201         }
 202     }
 203     if( bExecute )
 204     {
 205         if ( PushButton::ImplHitTestPushButton( this, rMEvt.GetPosPixel() ) )
 206         {
 207             if ( !(GetStyle() & WB_NOPOINTERFOCUS) )
 208                 GrabFocus();
 209             ExecuteMenu();
 210         }
 211     }
 212 }
 213
 214 void MenuButton::KeyInput( const KeyEvent& rKEvt )
 215 {
 216     vcl::KeyCode aKeyCode = rKEvt.GetKeyCode();
 217     sal_uInt16 nCode = aKeyCode.GetCode();
 218     if ( (nCode == KEY_DOWN) && aKeyCode.IsMod2() )
 219         ExecuteMenu();
 220     else if ( !mbDelayMenu &&
 221               !aKeyCode.GetModifier() &&
 222               ((nCode == KEY_RETURN) || (nCode == KEY_SPACE)) )
 223         ExecuteMenu();
 224     else
 225         PushButton::KeyInput( rKEvt );
 226 }
 227
 228 void MenuButton::Activate()
 229 {
 230     maActivateHdl.Call( this );
 231 }
 232
 233 void MenuButton::Select()
 234 {
 235     if (mnCurItemId)
 236         collectUIInformation(get_id(),"OPENFROMLIST","POS",OUString::number(mnCurItemId));
 237
 238     maSelectHdl.Call( this );
 239 }
 240
 241 void MenuButton::SetPopupMenu(PopupMenu* pNewMenu)
 242 {
 243     if (pNewMenu == mpMenu)
 244         return;
 245
 246     mpMenu = pNewMenu;
 247 }
 248
 249 void MenuButton::SetPopover(Window* pWindow)
 250 {
 251     if (pWindow == mpFloatingWindow)
 252         return;
 253
 254     mpFloatingWindow = pWindow;
 255 }
 256
 257
 258 FactoryFunction MenuButton::GetUITestFactory() const
 259 {
 260     return MenuButtonUIObject::create;
 261 }
 262
 263 void MenuButton::SetCurItemId(){
 264     mnCurItemId = mpMenu->GetCurItemId();
 265     msCurItemIdent = mpMenu->GetCurItemIdent();
 266 }
 267
 268 void MenuButton::DumpAsPropertyTree(tools::JsonWriter& rJsonWriter)
 269 {
 270     PushButton::DumpAsPropertyTree(rJsonWriter);
 271
 272     if (mpMenu)
 273     {
 274         auto aMenuNode = rJsonWriter.startArray("menu");
 275         for (int i = 0; i < mpMenu->GetItemCount(); i++)
 276         {
 277             auto aEntryNode = rJsonWriter.startStruct();
 278             auto sId = mpMenu->GetItemId(i);
 279             rJsonWriter.put("id", mpMenu->GetItemIdent(sId));
 280             rJsonWriter.put("text", mpMenu->GetItemText(sId));
 281         }
 282     }
 283 }
 284
 285 //class MenuToggleButton ----------------------------------------------------
 286
 287 MenuToggleButton::MenuToggleButton( vcl::Window* pParent, WinBits nWinBits )
 288     : MenuButton( pParent, nWinBits )
 289 {
 290 }
 291
 292 MenuToggleButton::~MenuToggleButton()
 293 {
 294     disposeOnce();
 295 }
 296
 297 void MenuToggleButton::SetActive( bool bSel )
 298 {
 299     mbIsActive = bSel;
 300 }
 301
 302 bool MenuToggleButton::GetActive() const
 303 {
 304     return mbIsActive;
 305 }
 306
 307 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */