vcl/inc/salvtables.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
   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 #pragma once
  10
  11 #include <vcl/builder.hxx>
  12 #include <vcl/weld.hxx>
  13 #include <vcl/svapp.hxx>
  14 #include <vcl/syswin.hxx>
  15 #include <vcl/settings.hxx>
  16 #include <vcl/virdev.hxx>
  17 #include <vcl/ctrl.hxx>
  18 #include <vcl/toolkit/edit.hxx>
  19 #include <vcl/formatter.hxx>
  20 #include <vcl/toolkit/spinfld.hxx>
  21 #include <vcl/toolkit/fixed.hxx>
  22 #include <vcl/toolkit/fixedhyper.hxx>
  23 #include <vcl/toolkit/lstbox.hxx>
  24 #include <vcl/toolkit/menubtn.hxx>
  25 #include <vcl/toolkit/prgsbar.hxx>
  26 #include <vcl/toolkit/combobox.hxx>
  27 #include <vcl/tabctrl.hxx>
  28 #include <vcl/layout.hxx>
  29 #include <vcl/toolkit/svtabbx.hxx>
  30 #include <vcl/toolkit/svlbitm.hxx>
  31 #include <o3tl/sorted_vector.hxx>
  32 #include "calendar.hxx"
  33 #include "iconview.hxx"
  34 #include "messagedialog.hxx"
  35 #include "verticaltabctrl.hxx"
  36
  37 namespace vcl
  38 {
  39 class RoadmapWizard;
  40 };
  41
  42 class SalInstanceBuilder : public weld::Builder
  43 {
  44 protected:
  45     std::unique_ptr<VclBuilder> m_xBuilder;
  46     VclPtr<vcl::Window> m_aOwnedToplevel;
  47
  48 public:
  49     SalInstanceBuilder(vcl::Window* pParent, std::u16string_view sUIRoot, const OUString& rUIFile,
  50                        const css::uno::Reference<css::frame::XFrame>& rFrame
  51                        = css::uno::Reference<css::frame::XFrame>());
  52
  53     virtual std::unique_ptr<weld::MessageDialog> weld_message_dialog(const OUString& id) override;
  54
  55     virtual std::unique_ptr<weld::Dialog> weld_dialog(const OUString& id) override;
  56
  57     virtual std::unique_ptr<weld::Assistant> weld_assistant(const OUString& id) override;
  58
  59     virtual std::unique_ptr<weld::Window> create_screenshot_window() override;
  60
  61     virtual std::unique_ptr<weld::Widget> weld_widget(const OUString& id) override;
  62
  63     virtual std::unique_ptr<weld::Container> weld_container(const OUString& id) override;
  64
  65     virtual std::unique_ptr<weld::Box> weld_box(const OUString& id) override;
  66
  67     virtual std::unique_ptr<weld::Paned> weld_paned(const OUString& id) override;
  68
  69     virtual std::unique_ptr<weld::Frame> weld_frame(const OUString& id) override;
  70
  71     virtual std::unique_ptr<weld::ScrolledWindow>
  72     weld_scrolled_window(const OUString& id, bool bUserManagedScrolling = false) override;
  73
  74     virtual std::unique_ptr<weld::Notebook> weld_notebook(const OUString& id) override;
  75
  76     virtual std::unique_ptr<weld::Button> weld_button(const OUString& id) override;
  77
  78     virtual std::unique_ptr<weld::MenuButton> weld_menu_button(const OUString& id) override;
  79
  80     virtual std::unique_ptr<weld::MenuToggleButton>
  81     weld_menu_toggle_button(const OUString& id) override;
  82
  83     virtual std::unique_ptr<weld::LinkButton> weld_link_button(const OUString& id) override;
  84
  85     virtual std::unique_ptr<weld::ToggleButton> weld_toggle_button(const OUString& id) override;
  86
  87     virtual std::unique_ptr<weld::RadioButton> weld_radio_button(const OUString& id) override;
  88
  89     virtual std::unique_ptr<weld::CheckButton> weld_check_button(const OUString& id) override;
  90
  91     virtual std::unique_ptr<weld::Scale> weld_scale(const OUString& id) override;
  92
  93     virtual std::unique_ptr<weld::ProgressBar> weld_progress_bar(const OUString& id) override;
  94
  95     virtual std::unique_ptr<weld::LevelBar> weld_level_bar(const OUString& id) override;
  96
  97     virtual std::unique_ptr<weld::Spinner> weld_spinner(const OUString& id) override;
  98
  99     virtual std::unique_ptr<weld::Image> weld_image(const OUString& id) override;
 100
 101     virtual std::unique_ptr<weld::Calendar> weld_calendar(const OUString& id) override;
 102
 103     virtual std::unique_ptr<weld::Entry> weld_entry(const OUString& id) override;
 104
 105     virtual std::unique_ptr<weld::SpinButton> weld_spin_button(const OUString& id) override;
 106
 107     virtual std::unique_ptr<weld::MetricSpinButton>
 108     weld_metric_spin_button(const OUString& id, FieldUnit eUnit) override;
 109
 110     virtual std::unique_ptr<weld::FormattedSpinButton>
 111     weld_formatted_spin_button(const OUString& id) override;
 112
 113     virtual std::unique_ptr<weld::ComboBox> weld_combo_box(const OUString& id) override;
 114
 115     virtual std::unique_ptr<weld::EntryTreeView>
 116     weld_entry_tree_view(const OUString& containerid, const OUString& entryid,
 117                          const OUString& treeviewid) override;
 118
 119     virtual std::unique_ptr<weld::TreeView> weld_tree_view(const OUString& id) override;
 120
 121     virtual std::unique_ptr<weld::IconView> weld_icon_view(const OUString& id) override;
 122
 123     virtual std::unique_ptr<weld::Label> weld_label(const OUString& id) override;
 124
 125     virtual std::unique_ptr<weld::TextView> weld_text_view(const OUString& id) override;
 126
 127     virtual std::unique_ptr<weld::Expander> weld_expander(const OUString& id) override;
 128
 129     virtual std::unique_ptr<weld::DrawingArea>
 130     weld_drawing_area(const OUString& id, const a11yref& rA11yImpl = nullptr,
 131                       FactoryFunction pUITestFactoryFunction = nullptr,
 132                       void* pUserData = nullptr) override;
 133
 134     virtual std::unique_ptr<weld::Menu> weld_menu(const OUString& id) override;
 135
 136     virtual std::unique_ptr<weld::Popover> weld_popover(const OUString& id) override;
 137
 138     virtual std::unique_ptr<weld::Toolbar> weld_toolbar(const OUString& id) override;
 139
 140     virtual std::unique_ptr<weld::Scrollbar> weld_scrollbar(const OUString& id) override;
 141
 142     virtual std::unique_ptr<weld::SizeGroup> create_size_group() override;
 143
 144     OUString get_current_page_help_id() const;
 145
 146     virtual ~SalInstanceBuilder() override;
 147 };
 148
 149 class SAL_DLLPUBLIC_RTTI SalInstanceMenu : public weld::Menu
 150 {
 151 protected:
 152     VclPtr<PopupMenu> m_xMenu;
 153
 154 private:
 155     bool m_bTakeOwnership;
 156     sal_uInt16 m_nLastId;
 157
 158     DECL_DLLPRIVATE_LINK(SelectMenuHdl, ::Menu*, bool);
 159
 160 public:
 161     SalInstanceMenu(PopupMenu* pMenu, bool bTakeOwnership);
 162     virtual OUString popup_at_rect(weld::Widget* pParent, const tools::Rectangle& rRect,
 163                                    weld::Placement ePlace = weld::Placement::Under) override;
 164     virtual void set_sensitive(const OUString& rIdent, bool bSensitive) override;
 165     virtual bool get_sensitive(const OUString& rIdent) const override;
 166     virtual void set_active(const OUString& rIdent, bool bActive) override;
 167     virtual bool get_active(const OUString& rIdent) const override;
 168     virtual void set_label(const OUString& rIdent, const OUString& rLabel) override;
 169     virtual OUString get_label(const OUString& rIdent) const override;
 170     virtual void set_visible(const OUString& rIdent, bool bShow) override;
 171     virtual void clear() override;
 172     virtual void insert(int pos, const OUString& rId, const OUString& rStr,
 173                         const OUString* pIconName, VirtualDevice* pImageSurface,
 174                         const css::uno::Reference<css::graphic::XGraphic>& rImage,
 175                         TriState eCheckRadioFalse) override;
 176     virtual void insert_separator(int pos, const OUString& rId) override;
 177     virtual void set_item_help_id(const OUString& rIdent, const OUString& rHelpId) override;
 178     virtual void remove(const OUString& rId) override;
 179     virtual OUString get_id(int pos) const override;
 180     virtual int n_children() const override;
 181     PopupMenu* getMenu() const;
 182     virtual ~SalInstanceMenu() override;
 183 };
 184
 185 class SalFlashAttention;
 186
 187 class VCL_DLLPUBLIC SalInstanceWidget : public virtual weld::Widget
 188 {
 189 protected:
 190     VclPtr<vcl::Window> m_xWidget;
 191     std::unique_ptr<SalFlashAttention> m_xFlashAttention;
 192     SalInstanceBuilder* m_pBuilder;
 193
 194 private:
 195     DECL_LINK(EventListener, VclWindowEvent&, void);
 196     DECL_LINK(KeyEventListener, VclWindowEvent&, bool);
 197     DECL_LINK(MouseEventListener, VclWindowEvent&, void);
 198     DECL_LINK(SettingsChangedHdl, VclWindowEvent&, void);
 199     DECL_LINK(MnemonicActivateHdl, vcl::Window&, bool);
 200
 201     static void DoRecursivePaint(vcl::Window* pWindow, const Point& rPos, OutputDevice& rOutput);
 202
 203     const bool m_bTakeOwnership;
 204     bool m_bEventListener;
 205     bool m_bKeyEventListener;
 206     bool m_bMouseEventListener;
 207     int m_nBlockNotify;
 208     int m_nFreezeCount;
 209
 210 protected:
 211     void ensure_event_listener();
 212
 213     // we want the ability to mark key events as handled, so use this variant
 214     // for those, we get all keystrokes in this case, so we will need to filter
 215     // them later
 216     void ensure_key_listener();
 217
 218     // we want the ability to know about mouse events that happen in our children
 219     // so use this variant, we will need to filter them later
 220     void ensure_mouse_listener();
 221
 222     bool IsFirstFreeze() const { return m_nFreezeCount == 0; }
 223     bool IsLastThaw() const { return m_nFreezeCount == 1; }
 224
 225     virtual void HandleEventListener(VclWindowEvent& rEvent);
 226     virtual bool HandleKeyEventListener(VclWindowEvent& rEvent);
 227     virtual void HandleMouseEventListener(VclWindowEvent& rEvent);
 228
 229 public:
 230     SalInstanceWidget(vcl::Window* pWidget, SalInstanceBuilder* pBuilder, bool bTakeOwnership);
 231
 232     virtual void set_sensitive(bool sensitive) override;
 233
 234     virtual bool get_sensitive() const override;
 235
 236     virtual bool get_visible() const override;
 237
 238     virtual bool is_visible() const override;
 239
 240     virtual void set_can_focus(bool bCanFocus) override;
 241
 242     virtual void grab_focus() override;
 243
 244     virtual bool has_focus() const override;
 245
 246     virtual bool is_active() const override;
 247
 248     virtual bool has_child_focus() const override;
 249
 250     virtual void show() override;
 251
 252     virtual void hide() override;
 253
 254     virtual void set_size_request(int nWidth, int nHeight) override;
 255
 256     virtual Size get_size_request() const override;
 257
 258     virtual Size get_preferred_size() const override;
 259
 260     virtual float get_approximate_digit_width() const override;
 261
 262     virtual int get_text_height() const override;
 263
 264     virtual Size get_pixel_size(const OUString& rText) const override;
 265
 266     virtual vcl::Font get_font() override;
 267
 268     virtual OUString get_buildable_name() const override;
 269
 270     virtual void set_buildable_name(const OUString& rId) override;
 271
 272     virtual void set_help_id(const OUString& rId) override;
 273
 274     virtual OUString get_help_id() const override;
 275
 276     virtual void set_grid_left_attach(int nAttach) override;
 277
 278     virtual int get_grid_left_attach() const override;
 279
 280     virtual void set_grid_width(int nCols) override;
 281
 282     virtual void set_grid_top_attach(int nAttach) override;
 283
 284     virtual int get_grid_top_attach() const override;
 285
 286     virtual void set_hexpand(bool bExpand) override;
 287
 288     virtual bool get_hexpand() const override;
 289
 290     virtual void set_vexpand(bool bExpand) override;
 291
 292     virtual bool get_vexpand() const override;
 293
 294     virtual void set_margin_top(int nMargin) override;
 295
 296     virtual void set_margin_bottom(int nMargin) override;
 297
 298     virtual void set_margin_start(int nMargin) override;
 299
 300     virtual void set_margin_end(int nMargin) override;
 301
 302     virtual int get_margin_top() const override;
 303
 304     virtual int get_margin_bottom() const override;
 305
 306     virtual int get_margin_start() const override;
 307
 308     virtual int get_margin_end() const override;
 309
 310     virtual void set_accessible_name(const OUString& rName) override;
 311
 312     virtual void set_accessible_description(const OUString& rDescription) override;
 313
 314     virtual OUString get_accessible_name() const override;
 315
 316     virtual OUString get_accessible_description() const override;
 317
 318     virtual OUString get_accessible_id() const override;
 319
 320     virtual void set_accessible_relation_labeled_by(weld::Widget* pLabel) override;
 321
 322     virtual void set_tooltip_text(const OUString& rTip) override;
 323
 324     virtual OUString get_tooltip_text() const override;
 325
 326     virtual void set_cursor_data(void* pData) override;
 327
 328     virtual void connect_focus_in(const Link<Widget&, void>& rLink) override;
 329
 330     virtual void connect_mnemonic_activate(const Link<Widget&, bool>& rLink) override;
 331
 332     virtual void connect_focus_out(const Link<Widget&, void>& rLink) override;
 333
 334     virtual void connect_size_allocate(const Link<const Size&, void>& rLink) override;
 335
 336     virtual void connect_mouse_press(const Link<const MouseEvent&, bool>& rLink) override;
 337
 338     virtual void connect_mouse_move(const Link<const MouseEvent&, bool>& rLink) override;
 339
 340     virtual void connect_mouse_release(const Link<const MouseEvent&, bool>& rLink) override;
 341
 342     virtual void connect_key_press(const Link<const KeyEvent&, bool>& rLink) override;
 343
 344     virtual void connect_key_release(const Link<const KeyEvent&, bool>& rLink) override;
 345
 346     virtual void connect_style_updated(const Link<Widget&, void>& rLink) override;
 347
 348     virtual bool get_extents_relative_to(const Widget& rRelative, int& x, int& y, int& width,
 349                                          int& height) const override;
 350
 351     virtual void grab_add() override;
 352
 353     virtual bool has_grab() const override;
 354
 355     virtual void grab_remove() override;
 356
 357     virtual bool get_direction() const override;
 358
 359     virtual void set_direction(bool bRTL) override;
 360
 361     virtual void freeze() override;
 362
 363     virtual void thaw() override;
 364
 365     virtual void set_busy_cursor(bool bBusy) override;
 366
 367     virtual std::unique_ptr<weld::Container> weld_parent() const override;
 368
 369     virtual ~SalInstanceWidget() override;
 370
 371     vcl::Window* getWidget() const;
 372
 373     void disable_notify_events();
 374
 375     bool notify_events_disabled() const;
 376
 377     void enable_notify_events();
 378
 379     virtual void queue_resize() override;
 380
 381     virtual void help_hierarchy_foreach(const std::function<bool(const OUString&)>& func) override;
 382
 383     virtual OUString strip_mnemonic(const OUString& rLabel) const override;
 384     virtual OUString escape_ui_str(const OUString& rLabel) const override;
 385
 386     virtual VclPtr<VirtualDevice> create_virtual_device() const override;
 387
 388     virtual css::uno::Reference<css::datatransfer::dnd::XDropTarget> get_drop_target() override;
 389     virtual css::uno::Reference<css::datatransfer::clipboard::XClipboard>
 390     get_clipboard() const override;
 391
 392     virtual void connect_get_property_tree(const Link<tools::JsonWriter&, void>& rLink) override;
 393
 394     virtual void get_property_tree(tools::JsonWriter& rJsonWriter) override;
 395
 396     virtual void call_attention_to() override;
 397
 398     virtual void set_stack_background() override;
 399
 400     virtual void set_title_background() override;
 401
 402     virtual void set_toolbar_background() override;
 403
 404     virtual void set_highlight_background() override;
 405
 406     virtual void set_background(const Color& rColor) override;
 407
 408     virtual void draw(OutputDevice& rOutput, const Point& rPos, const Size& rSizePixel) override;
 409
 410     SystemWindow* getSystemWindow();
 411 };
 412
 413 class SalInstanceLabel : public SalInstanceWidget, public virtual weld::Label
 414 {
 415 private:
 416     // Control instead of FixedText so we can also use this for
 417     // SelectableFixedText which is derived from Edit. We just typically need
 418     // [G|S]etText which exists in their shared baseclass
 419     VclPtr<Control> m_xLabel;
 420
 421 public:
 422     SalInstanceLabel(Control* pLabel, SalInstanceBuilder* pBuilder, bool bTakeOwnership);
 423
 424     virtual void set_label(const OUString& rText) override;
 425
 426     virtual OUString get_label() const override;
 427
 428     virtual void set_mnemonic_widget(Widget* pTarget) override;
 429
 430     virtual void set_label_type(weld::LabelType eType) override;
 431
 432     virtual void set_font(const vcl::Font& rFont) override;
 433
 434     virtual void set_font_color(const Color& rColor) override;
 435 };
 436
 437 class SalInstanceContainer : public SalInstanceWidget, public virtual weld::Container
 438 {
 439     VclPtr<vcl::Window> m_xContainer;
 440
 441 public:
 442     SalInstanceContainer(vcl::Window* pContainer, SalInstanceBuilder* pBuilder,
 443                          bool bTakeOwnership);
 444     virtual void HandleEventListener(VclWindowEvent& rEvent) override;
 445     virtual void connect_container_focus_changed(const Link<Container&, void>& rLink) override;
 446     virtual void child_grab_focus() override;
 447     virtual void move(weld::Widget* pWidget, weld::Container* pNewParent) override;
 448     virtual css::uno::Reference<css::awt::XWindow> CreateChildFrame() override;
 449 };
 450
 451 class SalInstanceWindow : public SalInstanceContainer, public virtual weld::Window
 452 {
 453 private:
 454     VclPtr<vcl::Window> m_xWindow;
 455
 456     DECL_LINK(HelpHdl, vcl::Window&, bool);
 457
 458     void override_child_help(vcl::Window* pParent);
 459
 460     void clear_child_help(vcl::Window* pParent);
 461
 462     void recursively_unset_default_buttons();
 463
 464     void implResetDefault(const vcl::Window* _pWindow);
 465
 466 public:
 467     SalInstanceWindow(vcl::Window* pWindow, SalInstanceBuilder* pBuilder, bool bTakeOwnership);
 468
 469     virtual void set_title(const OUString& rTitle) override;
 470
 471     virtual OUString get_title() const override;
 472
 473     void help();
 474
 475     virtual css::uno::Reference<css::awt::XWindow> GetXWindow() override;
 476
 477     virtual void resize_to_request() override;
 478
 479     virtual void window_move(int x, int y) override;
 480
 481     virtual Size get_size() const override;
 482
 483     virtual Point get_position() const override;
 484
 485     virtual AbsoluteScreenPixelRectangle get_monitor_workarea() const override;
 486
 487     virtual bool get_resizable() const override;
 488
 489     virtual bool has_toplevel_focus() const override;
 490
 491     virtual void present() override;
 492
 493     virtual void change_default_widget(weld::Widget* pOld, weld::Widget* pNew) override;
 494
 495     virtual bool is_default_widget(const weld::Widget* pCandidate) const override;
 496
 497     virtual void set_window_state(const OUString& rStr) override;
 498
 499     virtual OUString get_window_state(vcl::WindowDataMask nMask) const override;
 500
 501     virtual SystemEnvData get_system_data() const override;
 502
 503     virtual weld::ScreenShotCollection collect_screenshot_data() override;
 504
 505     virtual VclPtr<VirtualDevice> screenshot() override;
 506
 507     virtual const vcl::ILibreOfficeKitNotifier* GetLOKNotifier() override;
 508
 509     virtual ~SalInstanceWindow() override;
 510 };
 511
 512 class SalInstanceDialog : public SalInstanceWindow, public virtual weld::Dialog
 513 {
 514 protected:
 515     VclPtr<::Dialog> m_xDialog;
 516
 517 private:
 518     // for calc ref dialog that shrink to range selection widgets and resize back
 519     VclPtr<vcl::Window> m_xRefEdit;
 520     std::vector<VclPtr<vcl::Window>> m_aHiddenWidgets; // vector of hidden Controls
 521     tools::Long m_nOldEditWidthReq; // Original width request of the input field
 522     sal_Int32 m_nOldBorderWidth; // border width for expanded dialog
 523
 524     DECL_LINK(PopupScreenShotMenuHdl, const CommandEvent&, bool);
 525
 526 public:
 527     SalInstanceDialog(::Dialog* pDialog, SalInstanceBuilder* pBuilder, bool bTakeOwnership);
 528
 529     virtual bool runAsync(std::shared_ptr<weld::DialogController> const& rxOwner,
 530                           const std::function<void(sal_Int32)>& rEndDialogFn) override;
 531
 532     virtual bool runAsync(std::shared_ptr<Dialog> const& rxSelf,
 533                           const std::function<void(sal_Int32)>& rEndDialogFn) override;
 534
 535     virtual void collapse(weld::Widget* pEdit, weld::Widget* pButton) override;
 536
 537     virtual void undo_collapse() override;
 538
 539     virtual void
 540     SetInstallLOKNotifierHdl(const Link<void*, vcl::ILibreOfficeKitNotifier*>& rLink) override;
 541
 542     virtual int run() override;
 543
 544     virtual void response(int nResponse) override;
 545
 546     virtual void add_button(const OUString& rText, int nResponse,
 547                             const OUString& rHelpId = {}) override;
 548
 549     virtual void set_modal(bool bModal) override;
 550
 551     virtual bool get_modal() const override;
 552
 553     virtual void set_centered_on_parent(bool /*bTrackGeometryRequests*/) override;
 554
 555     virtual std::unique_ptr<weld::Button> weld_button_for_response(int nResponse) override;
 556
 557     virtual void set_default_response(int nResponse) override;
 558
 559     virtual std::unique_ptr<weld::Container> weld_content_area() override;
 560 };
 561
 562 class SalInstanceAssistant : public SalInstanceDialog, public virtual weld::Assistant
 563 {
 564 protected:
 565     VclPtr<vcl::RoadmapWizard> m_xWizard;
 566
 567 private:
 568     std::vector<std::unique_ptr<SalInstanceContainer>> m_aPages;
 569     std::vector<VclPtr<TabPage>> m_aAddedPages;
 570     std::vector<int> m_aIds;
 571     std::vector<VclPtr<VclGrid>> m_aAddedGrids;
 572     Idle m_aUpdateRoadmapIdle;
 573
 574     int find_page(std::u16string_view rIdent) const;
 575     int find_id(int nId) const;
 576
 577     DECL_LINK(OnRoadmapItemSelected, LinkParamNone*, void);
 578     DECL_LINK(UpdateRoadmap_Hdl, Timer*, void);
 579
 580 public:
 581     SalInstanceAssistant(vcl::RoadmapWizard* pDialog, SalInstanceBuilder* pBuilder,
 582                          bool bTakeOwnership);
 583     virtual int get_current_page() const override;
 584     virtual int get_n_pages() const override;
 585     virtual OUString get_page_ident(int nPage) const override;
 586     virtual OUString get_current_page_ident() const override;
 587     virtual void set_current_page(int nPage) override;
 588     virtual void set_current_page(const OUString& rIdent) override;
 589     virtual void set_page_index(const OUString& rIdent, int nNewIndex) override;
 590     virtual weld::Container* append_page(const OUString& rIdent) override;
 591     virtual OUString get_page_title(const OUString& rIdent) const override;
 592     virtual void set_page_title(const OUString& rIdent, const OUString& rTitle) override;
 593     virtual void set_page_sensitive(const OUString& rIdent, bool bSensitive) override;
 594     virtual void set_page_side_help_id(const OUString& rHelpId) override;
 595     virtual void set_page_side_image(const OUString& rImage) override;
 596     std::unique_ptr<weld::Button> weld_button_for_response(int nResponse) override;
 597
 598     virtual ~SalInstanceAssistant() override;
 599 };
 600
 601 class WeldTextFilter final : public TextFilter
 602 {
 603 private:
 604     Link<OUString&, bool>& m_rInsertTextHdl;
 605
 606 public:
 607     WeldTextFilter(Link<OUString&, bool>& rInsertTextHdl);
 608
 609     virtual OUString filter(const OUString& rText) override;
 610 };
 611
 612 class SalInstanceEntry : public SalInstanceWidget, public virtual weld::Entry
 613 {
 614 private:
 615     VclPtr<::Edit> m_xEntry;
 616
 617     DECL_LINK(ChangeHdl, Edit&, void);
 618     DECL_LINK(CursorListener, VclWindowEvent&, void);
 619     DECL_LINK(ActivateHdl, Edit&, bool);
 620
 621     WeldTextFilter m_aTextFilter;
 622
 623 public:
 624     SalInstanceEntry(::Edit* pEntry, SalInstanceBuilder* pBuilder, bool bTakeOwnership);
 625
 626     virtual void set_text(const OUString& rText) override;
 627
 628     virtual OUString get_text() const override;
 629
 630     virtual void set_width_chars(int nChars) override;
 631
 632     virtual int get_width_chars() const override;
 633
 634     virtual void set_max_length(int nChars) override;
 635
 636     virtual void select_region(int nStartPos, int nEndPos) override;
 637
 638     bool get_selection_bounds(int& rStartPos, int& rEndPos) override;
 639
 640     virtual void replace_selection(const OUString& rText) override;
 641
 642     virtual void set_position(int nCursorPos) override;
 643
 644     virtual int get_position() const override;
 645
 646     virtual void set_editable(bool bEditable) override;
 647
 648     virtual bool get_editable() const override;
 649
 650     virtual void set_overwrite_mode(bool bOn) override;
 651
 652     virtual bool get_overwrite_mode() const override;
 653
 654     virtual void set_message_type(weld::EntryMessageType eType) override;
 655
 656     virtual void set_font(const vcl::Font& rFont) override;
 657
 658     virtual void set_font_color(const Color& rColor) override;
 659
 660     virtual void connect_cursor_position(const Link<Entry&, void>& rLink) override;
 661
 662     virtual void set_placeholder_text(const OUString& rText) override;
 663
 664     Edit& getEntry();
 665
 666     void fire_signal_changed();
 667
 668     virtual void cut_clipboard() override;
 669
 670     virtual void copy_clipboard() override;
 671
 672     virtual void paste_clipboard() override;
 673
 674     virtual void set_alignment(TxtAlign eXAlign) override;
 675
 676     virtual ~SalInstanceEntry() override;
 677 };
 678
 679 class SalInstanceSpinButton : public SalInstanceEntry, public virtual weld::SpinButton
 680 {
 681     VclPtr<FormattedField> m_xButton;
 682
 683 protected:
 684     Formatter& m_rFormatter;
 685
 686 private:
 687     DECL_LINK(UpDownHdl, SpinField&, void);
 688     DECL_LINK(LoseFocusHdl, Control&, void);
 689     DECL_LINK(OutputHdl, LinkParamNone*, bool);
 690     DECL_LINK(InputHdl, sal_Int64*, TriState);
 691     DECL_LINK(ActivateHdl, Edit&, bool);
 692
 693     double toField(sal_Int64 nValue) const;
 694
 695     sal_Int64 fromField(double fValue) const;
 696
 697 public:
 698     SalInstanceSpinButton(FormattedField* pButton, SalInstanceBuilder* pBuilder,
 699                           bool bTakeOwnership);
 700
 701     virtual sal_Int64 get_value() const override;
 702
 703     virtual void set_value(sal_Int64 value) override;
 704
 705     virtual void set_range(sal_Int64 min, sal_Int64 max) override;
 706
 707     virtual void get_range(sal_Int64& min, sal_Int64& max) const override;
 708
 709     virtual void set_increments(sal_Int64 step, sal_Int64 /*page*/) override;
 710
 711     virtual void get_increments(sal_Int64& step, sal_Int64& page) const override;
 712
 713     virtual void set_digits(unsigned int digits) override;
 714
 715     // SpinButton may be comprised of multiple subwidgets, consider the lot as
 716     // one thing for focus
 717     virtual bool has_focus() const override;
 718
 719     //off by default for direct SpinButtons, MetricSpinButton enables it
 720     void SetUseThousandSep();
 721
 722     virtual unsigned int get_digits() const override;
 723
 724     virtual ~SalInstanceSpinButton() override;
 725 };
 726
 727 //ComboBox and ListBox have similar apis, ComboBoxes in LibreOffice have an edit box and ListBoxes
 728 //don't. This distinction isn't there in Gtk. Use a template to sort this problem out.
 729 template <class vcl_type>
 730 class SalInstanceComboBox : public SalInstanceWidget, public virtual weld::ComboBox
 731 {
 732 protected:
 733     // owner for ListBox/ComboBox UserData
 734     std::vector<std::shared_ptr<OUString>> m_aUserData;
 735     VclPtr<vcl_type> m_xComboBox;
 736     ScopedVclPtr<MenuButton> m_xMenuButton;
 737     OUString m_sMenuButtonRow;
 738
 739 public:
 740     SalInstanceComboBox(vcl_type* pComboBox, SalInstanceBuilder* pBuilder, bool bTakeOwnership)
 741         : SalInstanceWidget(pComboBox, pBuilder, bTakeOwnership)
 742         , m_xComboBox(pComboBox)
 743     {
 744     }
 745
 746     virtual int get_active() const override
 747     {
 748         const sal_Int32 nRet = m_xComboBox->GetSelectedEntryPos();
 749         if (nRet == LISTBOX_ENTRY_NOTFOUND)
 750             return -1;
 751         return nRet;
 752     }
 753
 754     const OUString* getEntryData(int index) const
 755     {
 756         return static_cast<const OUString*>(m_xComboBox->GetEntryData(index));
 757     }
 758
 759     // ComboBoxes are comprised of multiple subwidgets, consider the lot as
 760     // one thing for focus
 761     virtual bool has_focus() const override
 762     {
 763         return m_xWidget->HasChildPathFocus()
 764                || (m_xMenuButton && (m_xMenuButton->HasFocus() || m_xMenuButton->InPopupMode()));
 765     }
 766
 767     virtual OUString get_active_id() const override
 768     {
 769         sal_Int32 nPos = m_xComboBox->GetSelectedEntryPos();
 770         const OUString* pRet;
 771         if (nPos != LISTBOX_ENTRY_NOTFOUND)
 772             pRet = getEntryData(m_xComboBox->GetSelectedEntryPos());
 773         else
 774             pRet = nullptr;
 775         if (!pRet)
 776             return OUString();
 777         return *pRet;
 778     }
 779
 780     virtual void set_active_id(const OUString& rStr) override
 781     {
 782         for (int i = 0; i < get_count(); ++i)
 783         {
 784             const OUString* pId = getEntryData(i);
 785             if (!pId)
 786                 continue;
 787             if (*pId == rStr)
 788                 m_xComboBox->SelectEntryPos(i);
 789         }
 790     }
 791
 792     virtual void set_active(int pos) override
 793     {
 794         assert(m_xComboBox->IsUpdateMode()
 795                && "don't set_active when frozen, set_active after thaw. Note selection doesn't "
 796                   "survive a "
 797                   "freeze");
 798         if (pos == -1)
 799         {
 800             m_xComboBox->SetNoSelection();
 801             return;
 802         }
 803         m_xComboBox->SelectEntryPos(pos);
 804     }
 805
 806     virtual OUString get_text(int pos) const override { return m_xComboBox->GetEntry(pos); }
 807
 808     virtual OUString get_id(int pos) const override
 809     {
 810         const OUString* pRet = getEntryData(pos);
 811         if (!pRet)
 812             return OUString();
 813         return *pRet;
 814     }
 815
 816     virtual void set_id(int row, const OUString& rId) override
 817     {
 818         m_aUserData.emplace_back(std::make_unique<OUString>(rId));
 819         m_xComboBox->SetEntryData(row, m_aUserData.back().get());
 820     }
 821
 822     virtual void insert_vector(const std::vector<weld::ComboBoxEntry>& rItems,
 823                                bool bKeepExisting) override
 824     {
 825         freeze();
 826         if (!bKeepExisting)
 827             clear();
 828         for (const auto& rItem : rItems)
 829         {
 830             insert(-1, rItem.sString, rItem.sId.isEmpty() ? nullptr : &rItem.sId,
 831                    rItem.sImage.isEmpty() ? nullptr : &rItem.sImage, nullptr);
 832         }
 833         thaw();
 834     }
 835
 836     virtual int get_count() const override { return m_xComboBox->GetEntryCount(); }
 837
 838     virtual int find_text(const OUString& rStr) const override
 839     {
 840         const sal_Int32 nRet = m_xComboBox->GetEntryPos(rStr);
 841         if (nRet == LISTBOX_ENTRY_NOTFOUND)
 842             return -1;
 843         return nRet;
 844     }
 845
 846     virtual int find_id(const OUString& rStr) const override
 847     {
 848         for (int i = 0; i < get_count(); ++i)
 849         {
 850             const OUString* pId = getEntryData(i);
 851             if (!pId)
 852                 continue;
 853             if (*pId == rStr)
 854                 return i;
 855         }
 856         return -1;
 857     }
 858
 859     virtual void clear() override
 860     {
 861         m_xComboBox->Clear();
 862         m_aUserData.clear();
 863     }
 864
 865     virtual void make_sorted() override
 866     {
 867         m_xComboBox->SetStyle(m_xComboBox->GetStyle() | WB_SORT);
 868     }
 869
 870     virtual bool get_popup_shown() const override { return m_xComboBox->IsInDropDown(); }
 871
 872     virtual void connect_popup_toggled(const Link<ComboBox&, void>& rLink) override
 873     {
 874         weld::ComboBox::connect_popup_toggled(rLink);
 875         ensure_event_listener();
 876     }
 877
 878     void call_signal_custom_render(UserDrawEvent* pEvent)
 879     {
 880         vcl::RenderContext* pRenderContext = pEvent->GetRenderContext();
 881         auto nPos = pEvent->GetItemId();
 882         const tools::Rectangle& rRect = pEvent->GetRect();
 883         const OUString sId = get_id(nPos);
 884         signal_custom_render(*pRenderContext, rRect, pEvent->IsSelected(), sId);
 885         m_xComboBox->DrawEntry(*pEvent); // draw separator
 886
 887         if (m_xMenuButton && m_xMenuButton->IsVisible() && m_sMenuButtonRow == sId)
 888         {
 889             vcl::Window* pEventWindow = m_xComboBox->GetMainWindow();
 890             if (m_xMenuButton->GetParent() != pEventWindow)
 891                 m_xMenuButton->SetParent(pEventWindow);
 892             int nButtonWidth = get_menu_button_width();
 893             m_xMenuButton->SetSizePixel(Size(nButtonWidth, rRect.GetHeight()));
 894             m_xMenuButton->SetPosPixel(Point(rRect.GetWidth() - nButtonWidth, rRect.Top()));
 895         }
 896     }
 897
 898     VclPtr<VirtualDevice> create_render_virtual_device() const override
 899     {
 900         auto xRet = VclPtr<VirtualDevice>::Create();
 901         xRet->SetBackground(Application::GetSettings().GetStyleSettings().GetFieldColor());
 902         return xRet;
 903     }
 904
 905     virtual void set_item_menu(const OUString& rIdent, weld::Menu* pMenu) override
 906     {
 907         SalInstanceMenu* pInstanceMenu = dynamic_cast<SalInstanceMenu*>(pMenu);
 908
 909         PopupMenu* pPopup = pInstanceMenu ? pInstanceMenu->getMenu() : nullptr;
 910
 911         if (!m_xMenuButton)
 912             m_xMenuButton
 913                 = VclPtr<MenuButton>::Create(m_xComboBox, WB_FLATBUTTON | WB_NOPOINTERFOCUS);
 914
 915         m_xMenuButton->SetPopupMenu(pPopup, false);
 916         m_xMenuButton->Show(pPopup != nullptr);
 917         m_sMenuButtonRow = rIdent;
 918     }
 919
 920     int get_menu_button_width() const override
 921     {
 922         OutputDevice* pDefault = Application::GetDefaultDevice();
 923         return 20 * (pDefault ? pDefault->GetDPIScaleFactor() : 1.0);
 924     }
 925
 926     void set_max_drop_down_rows(int nRows) override { m_xComboBox->SetDropDownLineCount(nRows); }
 927
 928     void CallHandleEventListener(VclWindowEvent& rEvent)
 929     {
 930         if (rEvent.GetId() == VclEventId::DropdownPreOpen
 931             || rEvent.GetId() == VclEventId::DropdownClose)
 932         {
 933             signal_popup_toggled();
 934             return;
 935         }
 936         SalInstanceWidget::HandleEventListener(rEvent);
 937     }
 938 };
 939
 940 class SalInstanceComboBoxWithoutEdit : public SalInstanceComboBox<ListBox>
 941 {
 942 private:
 943     DECL_LINK(SelectHdl, ListBox&, void);
 944
 945 public:
 946     SalInstanceComboBoxWithoutEdit(ListBox* pListBox, SalInstanceBuilder* pBuilder,
 947                                    bool bTakeOwnership);
 948
 949     virtual OUString get_active_text() const override;
 950
 951     virtual void remove(int pos) override;
 952
 953     virtual void insert(int pos, const OUString& rStr, const OUString* pId,
 954                         const OUString* pIconName, VirtualDevice* pImageSurface) override;
 955
 956     virtual void insert_separator(int pos, const OUString& /*rId*/) override;
 957
 958     virtual bool has_entry() const override;
 959
 960     virtual bool changed_by_direct_pick() const override;
 961
 962     virtual void set_entry_message_type(weld::EntryMessageType /*eType*/) override;
 963
 964     virtual void set_entry_text(const OUString& /*rText*/) override;
 965
 966     virtual void select_entry_region(int /*nStartPos*/, int /*nEndPos*/) override;
 967
 968     virtual bool get_entry_selection_bounds(int& /*rStartPos*/, int& /*rEndPos*/) override;
 969
 970     virtual void set_entry_width_chars(int /*nChars*/) override;
 971
 972     virtual void set_entry_max_length(int /*nChars*/) override;
 973
 974     virtual void set_entry_completion(bool, bool bCaseSensitive = false) override;
 975
 976     virtual void set_entry_placeholder_text(const OUString&) override;
 977
 978     virtual void set_entry_editable(bool bEditable) override;
 979
 980     virtual void cut_entry_clipboard() override;
 981
 982     virtual void copy_entry_clipboard() override;
 983
 984     virtual void paste_entry_clipboard() override;
 985
 986     virtual void set_font(const vcl::Font& rFont) override;
 987
 988     virtual void set_entry_font(const vcl::Font&) override;
 989
 990     virtual vcl::Font get_entry_font() override;
 991
 992     virtual void set_custom_renderer(bool bOn) override;
 993
 994     virtual int get_max_mru_count() const override;
 995
 996     virtual void set_max_mru_count(int) override;
 997
 998     virtual OUString get_mru_entries() const override;
 999
1000     virtual void set_mru_entries(const OUString&) override;
1001
1002     virtual void HandleEventListener(VclWindowEvent& rEvent) override;
1003
1004     virtual ~SalInstanceComboBoxWithoutEdit() override;
1005 };
1006
1007 class SalInstanceComboBoxWithEdit : public SalInstanceComboBox<ComboBox>
1008 {
1009 private:
1010     DECL_LINK(ChangeHdl, Edit&, void);
1011     DECL_LINK(EntryActivateHdl, Edit&, bool);
1012     DECL_LINK(SelectHdl, ::ComboBox&, void);
1013     DECL_LINK(UserDrawHdl, UserDrawEvent*, void);
1014     WeldTextFilter m_aTextFilter;
1015     bool m_bInSelect;
1016
1017 public:
1018     SalInstanceComboBoxWithEdit(::ComboBox* pComboBox, SalInstanceBuilder* pBuilder,
1019                                 bool bTakeOwnership);
1020
1021     virtual bool has_entry() const override;
1022
1023     virtual bool changed_by_direct_pick() const override;
1024
1025     virtual void set_entry_message_type(weld::EntryMessageType eType) override;
1026
1027     virtual OUString get_active_text() const override;
1028
1029     virtual void remove(int pos) override;
1030
1031     virtual void insert(int pos, const OUString& rStr, const OUString* pId,
1032                         const OUString* pIconName, VirtualDevice* pImageSurface) override;
1033
1034     virtual void insert_separator(int pos, const OUString& /*rId*/) override;
1035
1036     virtual void set_entry_text(const OUString& rText) override;
1037
1038     virtual void set_entry_width_chars(int nChars) override;
1039
1040     virtual void set_entry_max_length(int nChars) override;
1041
1042     virtual void set_entry_completion(bool bEnable, bool bCaseSensitive = false) override;
1043
1044     virtual void set_entry_placeholder_text(const OUString& rText) override;
1045
1046     virtual void set_entry_editable(bool bEditable) override;
1047
1048     virtual void cut_entry_clipboard() override;
1049
1050     virtual void copy_entry_clipboard() override;
1051
1052     virtual void paste_entry_clipboard() override;
1053
1054     virtual void select_entry_region(int nStartPos, int nEndPos) override;
1055
1056     virtual bool get_entry_selection_bounds(int& rStartPos, int& rEndPos) override;
1057
1058     virtual void set_font(const vcl::Font& rFont) override;
1059
1060     virtual void set_entry_font(const vcl::Font& rFont) override;
1061
1062     virtual vcl::Font get_entry_font() override;
1063
1064     virtual void set_custom_renderer(bool bOn) override;
1065
1066     virtual int get_max_mru_count() const override;
1067
1068     virtual void set_max_mru_count(int nCount) override;
1069
1070     virtual OUString get_mru_entries() const override;
1071
1072     virtual void set_mru_entries(const OUString& rEntries) override;
1073
1074     virtual void HandleEventListener(VclWindowEvent& rEvent) override;
1075
1076     virtual void call_attention_to() override;
1077
1078     virtual ~SalInstanceComboBoxWithEdit() override;
1079 };
1080
1081 class SalInstanceButton : public SalInstanceWidget, public virtual weld::Button
1082 {
1083 private:
1084     VclPtr<::Button> m_xButton;
1085     Link<::Button*, void> const m_aOldClickHdl;
1086
1087     DECL_LINK(ClickHdl, ::Button*, void);
1088
1089 public:
1090     SalInstanceButton(::Button* pButton, SalInstanceBuilder* pBuilder, bool bTakeOwnership);
1091
1092     virtual void set_label(const OUString& rText) override;
1093
1094     virtual void set_image(VirtualDevice* pDevice) override;
1095
1096     virtual void set_image(const css::uno::Reference<css::graphic::XGraphic>& rImage) override;
1097
1098     virtual void set_from_icon_name(const OUString& rIconName) override;
1099
1100     virtual OUString get_label() const override;
1101
1102     virtual void set_font(const vcl::Font& rFont) override;
1103
1104     virtual void set_custom_button(VirtualDevice* pDevice) override;
1105
1106     virtual ~SalInstanceButton() override;
1107 };
1108
1109 class SalInstanceToggleButton : public SalInstanceButton, public virtual weld::ToggleButton
1110 {
1111 private:
1112     VclPtr<PushButton> m_xToggleButton;
1113
1114     DECL_LINK(ToggleListener, VclWindowEvent&, void);
1115
1116 public:
1117     SalInstanceToggleButton(PushButton* pButton, SalInstanceBuilder* pBuilder, bool bTakeOwnership)
1118         : SalInstanceButton(pButton, pBuilder, bTakeOwnership)
1119         , m_xToggleButton(pButton)
1120     {
1121         m_xToggleButton->setToggleButton(true);
1122     }
1123
1124     virtual void connect_toggled(const Link<Toggleable&, void>& rLink) override
1125     {
1126         assert(!m_aToggleHdl.IsSet());
1127         m_xToggleButton->AddEventListener(LINK(this, SalInstanceToggleButton, ToggleListener));
1128         weld::ToggleButton::connect_toggled(rLink);
1129     }
1130
1131     virtual void set_active(bool active) override
1132     {
1133         disable_notify_events();
1134         m_xToggleButton->Check(active);
1135         enable_notify_events();
1136     }
1137
1138     virtual bool get_active() const override { return m_xToggleButton->IsChecked(); }
1139
1140     virtual void set_inconsistent(bool inconsistent) override
1141     {
1142         disable_notify_events();
1143         m_xToggleButton->SetState(inconsistent ? TRISTATE_INDET : TRISTATE_FALSE);
1144         enable_notify_events();
1145     }
1146
1147     virtual bool get_inconsistent() const override
1148     {
1149         return m_xToggleButton->GetState() == TRISTATE_INDET;
1150     }
1151
1152     virtual ~SalInstanceToggleButton() override
1153     {
1154         if (m_aToggleHdl.IsSet())
1155             m_xToggleButton->RemoveEventListener(
1156                 LINK(this, SalInstanceToggleButton, ToggleListener));
1157     }
1158 };
1159
1160 class SalInstanceNotebook : public SalInstanceWidget, public virtual weld::Notebook
1161 {
1162 private:
1163     VclPtr<TabControl> m_xNotebook;
1164     /// Constructed on-demand.
1165     mutable std::map<OUString, std::shared_ptr<SalInstanceContainer>> m_aPages;
1166     std::map<OUString, std::pair<VclPtr<TabPage>, VclPtr<VclGrid>>> m_aAddedPages;
1167
1168     DECL_LINK(DeactivatePageHdl, TabControl*, bool);
1169     DECL_LINK(ActivatePageHdl, TabControl*, void);
1170
1171 public:
1172     SalInstanceNotebook(TabControl* pNotebook, SalInstanceBuilder* pBuilder, bool bTakeOwnership);
1173
1174     virtual int get_current_page() const override;
1175
1176     virtual int get_page_index(const OUString& rIdent) const override;
1177
1178     virtual OUString get_page_ident(int nPage) const override;
1179
1180     virtual OUString get_current_page_ident() const override;
1181
1182     virtual weld::Container* get_page(const OUString& rIdent) const override;
1183
1184     virtual void set_current_page(int nPage) override;
1185
1186     virtual void set_current_page(const OUString& rIdent) override;
1187
1188     virtual void remove_page(const OUString& rIdent) override;
1189
1190     virtual void insert_page(const OUString& rIdent, const OUString& rLabel, int nPos) override;
1191
1192     virtual int get_n_pages() const override;
1193
1194     virtual OUString get_tab_label_text(const OUString& rIdent) const override;
1195
1196     virtual void set_tab_label_text(const OUString& rIdent, const OUString& rText) override;
1197
1198     virtual void set_show_tabs(bool bShow) override;
1199
1200     virtual ~SalInstanceNotebook() override;
1201 };
1202
1203 class SalInstanceMessageDialog : public SalInstanceDialog, public virtual weld::MessageDialog
1204 {
1205 protected:
1206     VclPtr<::MessageDialog> m_xMessageDialog;
1207
1208 public:
1209     SalInstanceMessageDialog(::MessageDialog* pDialog, SalInstanceBuilder* pBuilder,
1210                              bool bTakeOwnership);
1211
1212     virtual void set_primary_text(const OUString& rText) override;
1213
1214     virtual OUString get_primary_text() const override;
1215
1216     virtual void set_secondary_text(const OUString& rText) override;
1217
1218     virtual OUString get_secondary_text() const override;
1219
1220     virtual std::unique_ptr<weld::Container> weld_message_area() override;
1221 };
1222
1223 class SalInstanceLinkButton : public SalInstanceWidget, public virtual weld::LinkButton
1224 {
1225 private:
1226     VclPtr<FixedHyperlink> m_xButton;
1227     Link<FixedHyperlink&, void> m_aOrigClickHdl;
1228
1229     DECL_LINK(ClickHdl, FixedHyperlink&, void);
1230
1231 public:
1232     SalInstanceLinkButton(FixedHyperlink* pButton, SalInstanceBuilder* pBuilder,
1233                           bool bTakeOwnership)
1234         : SalInstanceWidget(pButton, pBuilder, bTakeOwnership)
1235         , m_xButton(pButton)
1236     {
1237         m_aOrigClickHdl = m_xButton->GetClickHdl();
1238         m_xButton->SetClickHdl(LINK(this, SalInstanceLinkButton, ClickHdl));
1239     }
1240
1241     virtual void set_label(const OUString& rText) override { m_xButton->SetText(rText); }
1242
1243     virtual OUString get_label() const override { return m_xButton->GetText(); }
1244
1245     virtual void set_uri(const OUString& rUri) override { m_xButton->SetURL(rUri); }
1246
1247     virtual OUString get_uri() const override { return m_xButton->GetURL(); }
1248
1249     virtual void set_label_wrap(bool wrap) override;
1250
1251     virtual ~SalInstanceLinkButton() override { m_xButton->SetClickHdl(m_aOrigClickHdl); }
1252 };
1253
1254 class SalInstanceCheckButton : public SalInstanceButton, public virtual weld::CheckButton
1255 {
1256 private:
1257     VclPtr<CheckBox> m_xCheckButton;
1258
1259     DECL_LINK(ToggleHdl, CheckBox&, void);
1260
1261 public:
1262     SalInstanceCheckButton(CheckBox* pButton, SalInstanceBuilder* pBuilder, bool bTakeOwnership);
1263
1264     virtual void set_active(bool active) override;
1265
1266     virtual bool get_active() const override;
1267
1268     virtual void set_inconsistent(bool inconsistent) override;
1269
1270     virtual bool get_inconsistent() const override;
1271
1272     virtual void set_label(const OUString& rText) override { SalInstanceButton::set_label(rText); }
1273
1274     virtual OUString get_label() const override { return SalInstanceButton::get_label(); }
1275
1276     virtual void set_label_wrap(bool wrap) override;
1277
1278     virtual ~SalInstanceCheckButton() override;
1279 };
1280
1281 class SalInstanceDrawingArea : public SalInstanceWidget, public virtual weld::DrawingArea
1282 {
1283 private:
1284     VclPtr<VclDrawingArea> m_xDrawingArea;
1285
1286     typedef std::pair<vcl::RenderContext&, const tools::Rectangle&> target_and_area;
1287     DECL_LINK(PaintHdl, target_and_area, void);
1288     DECL_LINK(ResizeHdl, const Size&, void);
1289     DECL_LINK(MousePressHdl, const MouseEvent&, bool);
1290     DECL_LINK(MouseMoveHdl, const MouseEvent&, bool);
1291     DECL_LINK(MouseReleaseHdl, const MouseEvent&, bool);
1292     DECL_LINK(KeyPressHdl, const KeyEvent&, bool);
1293     DECL_LINK(KeyReleaseHdl, const KeyEvent&, bool);
1294     DECL_LINK(StyleUpdatedHdl, VclDrawingArea&, void);
1295     DECL_LINK(CommandHdl, const CommandEvent&, bool);
1296     DECL_LINK(QueryTooltipHdl, tools::Rectangle&, OUString);
1297     DECL_LINK(GetSurroundingHdl, OUString&, int);
1298     DECL_LINK(DeleteSurroundingHdl, const Selection&, bool);
1299     DECL_LINK(StartDragHdl, VclDrawingArea*, bool);
1300
1301     // SalInstanceWidget has a generic listener for all these
1302     // events, ignore the ones we have specializations for
1303     // in VclDrawingArea
1304     virtual void HandleEventListener(VclWindowEvent& rEvent) override;
1305
1306     virtual void HandleMouseEventListener(VclWindowEvent& rEvent) override;
1307
1308     virtual bool HandleKeyEventListener(VclWindowEvent& /*rEvent*/) override;
1309
1310 public:
1311     SalInstanceDrawingArea(VclDrawingArea* pDrawingArea, SalInstanceBuilder* pBuilder,
1312                            const a11yref& rAlly, FactoryFunction pUITestFactoryFunction,
1313                            void* pUserData, bool bTakeOwnership);
1314
1315     virtual void queue_draw() override;
1316
1317     virtual void queue_draw_area(int x, int y, int width, int height) override;
1318
1319     virtual void connect_size_allocate(const Link<const Size&, void>& rLink) override;
1320
1321     virtual void connect_key_press(const Link<const KeyEvent&, bool>& rLink) override;
1322
1323     virtual void connect_key_release(const Link<const KeyEvent&, bool>& rLink) override;
1324
1325     virtual void connect_style_updated(const Link<Widget&, void>& rLink) override;
1326
1327     virtual void set_cursor(PointerStyle ePointerStyle) override;
1328
1329     virtual Point get_pointer_position() const override;
1330
1331     virtual void set_input_context(const InputContext& rInputContext) override;
1332
1333     virtual void im_context_set_cursor_location(const tools::Rectangle& rCursorRect,
1334                                                 int nExtTextInputWidth) override;
1335
1336     virtual a11yref get_accessible_parent() override;
1337
1338     virtual a11yrelationset get_accessible_relation_set() override;
1339
1340     virtual AbsoluteScreenPixelPoint get_accessible_location_on_screen() override;
1341
1342     virtual void enable_drag_source(rtl::Reference<TransferDataContainer>& rHelper,
1343                                     sal_uInt8 eDNDConstants) override;
1344
1345     virtual ~SalInstanceDrawingArea() override;
1346
1347     virtual OutputDevice& get_ref_device() override;
1348
1349     virtual void click(const Point& rPos) override;
1350
1351     virtual void dblclick(const Point& rPos) override;
1352
1353     virtual void mouse_up(const Point& rPos) override;
1354
1355     virtual void mouse_down(const Point& rPos) override;
1356
1357     virtual void mouse_move(const Point& rPos) override;
1358 };
1359
1360 class SalInstanceToolbar : public SalInstanceWidget, public virtual weld::Toolbar
1361 {
1362 protected:
1363     VclPtr<ToolBox> m_xToolBox;
1364     std::map<ToolBoxItemId, VclPtr<vcl::Window>> m_aFloats;
1365     std::map<ToolBoxItemId, VclPtr<PopupMenu>> m_aMenus;
1366
1367     OUString m_sStartShowIdent;
1368
1369     DECL_LINK(ClickHdl, ToolBox*, void);
1370     DECL_LINK(DropdownClick, ToolBox*, void);
1371     DECL_LINK(MenuToggleListener, VclWindowEvent&, void);
1372
1373 public:
1374     SalInstanceToolbar(ToolBox* pToolBox, SalInstanceBuilder* pBuilder, bool bTakeOwnership);
1375
1376     virtual void set_item_sensitive(const OUString& rIdent, bool bSensitive) override;
1377
1378     virtual bool get_item_sensitive(const OUString& rIdent) const override;
1379
1380     virtual void set_item_visible(const OUString& rIdent, bool bVisible) override;
1381
1382     virtual void set_item_help_id(const OUString& rIdent, const OUString& rHelpId) override;
1383
1384     virtual bool get_item_visible(const OUString& rIdent) const override;
1385
1386     virtual void set_item_active(const OUString& rIdent, bool bActive) override;
1387
1388     virtual bool get_item_active(const OUString& rIdent) const override;
1389
1390     void set_menu_item_active(const OUString& rIdent, bool bActive) override;
1391
1392     bool get_menu_item_active(const OUString& rIdent) const override;
1393
1394     virtual void set_item_popover(const OUString& rIdent, weld::Widget* pPopover) override;
1395
1396     virtual void set_item_menu(const OUString& rIdent, weld::Menu* pMenu) override;
1397
1398     virtual void insert_item(int pos, const OUString& rId) override;
1399
1400     virtual void insert_separator(int pos, const OUString& /*rId*/) override;
1401
1402     virtual int get_n_items() const override;
1403
1404     virtual OUString get_item_ident(int nIndex) const override;
1405
1406     virtual void set_item_ident(int nIndex, const OUString& rIdent) override;
1407
1408     virtual void set_item_label(int nIndex, const OUString& rLabel) override;
1409
1410     virtual OUString get_item_label(const OUString& rIdent) const override;
1411
1412     virtual void set_item_label(const OUString& rIdent, const OUString& rLabel) override;
1413
1414     virtual void set_item_icon_name(const OUString& rIdent, const OUString& rIconName) override;
1415
1416     virtual void set_item_image_mirrored(const OUString& rIdent, bool bMirrored) override;
1417
1418     virtual void set_item_image(const OUString& rIdent,
1419                                 const css::uno::Reference<css::graphic::XGraphic>& rIcon) override;
1420
1421     virtual void set_item_image(const OUString& rIdent, VirtualDevice* pDevice) override;
1422
1423     virtual void set_item_image(int nIndex,
1424                                 const css::uno::Reference<css::graphic::XGraphic>& rIcon) override;
1425
1426     virtual void set_item_tooltip_text(int nIndex, const OUString& rTip) override;
1427
1428     virtual void set_item_tooltip_text(const OUString& rIdent, const OUString& rTip) override;
1429
1430     virtual void set_item_accessible_name(int nIndex, const OUString& rName) override;
1431
1432     virtual void set_item_accessible_name(const OUString& rIdent, const OUString& rName) override;
1433
1434     virtual OUString get_item_tooltip_text(const OUString& rIdent) const override;
1435
1436     virtual vcl::ImageType get_icon_size() const override;
1437
1438     virtual void set_icon_size(vcl::ImageType eType) override;
1439
1440     virtual sal_uInt16 get_modifier_state() const override;
1441
1442     virtual int get_drop_index(const Point& rPoint) const override;
1443
1444     virtual ~SalInstanceToolbar() override;
1445 };
1446
1447 class SalInstanceTextView : public SalInstanceWidget, public virtual weld::TextView
1448 {
1449 private:
1450     VclPtr<VclMultiLineEdit> m_xTextView;
1451     Link<ScrollBar*, void> m_aOrigVScrollHdl;
1452
1453     DECL_LINK(ChangeHdl, Edit&, void);
1454     DECL_LINK(VscrollHdl, ScrollBar*, void);
1455     DECL_LINK(CursorListener, VclWindowEvent&, void);
1456
1457 public:
1458     SalInstanceTextView(VclMultiLineEdit* pTextView, SalInstanceBuilder* pBuilder,
1459                         bool bTakeOwnership);
1460
1461     virtual void set_text(const OUString& rText) override;
1462
1463     virtual void replace_selection(const OUString& rText) override;
1464
1465     virtual OUString get_text() const override;
1466
1467     bool get_selection_bounds(int& rStartPos, int& rEndPos) override;
1468
1469     virtual void select_region(int nStartPos, int nEndPos) override;
1470
1471     virtual void set_editable(bool bEditable) override;
1472     virtual bool get_editable() const override;
1473     virtual void set_max_length(int nChars) override;
1474
1475     virtual void set_monospace(bool bMonospace) override;
1476
1477     virtual void set_font(const vcl::Font& rFont) override;
1478
1479     virtual void set_font_color(const Color& rColor) override;
1480
1481     virtual void connect_cursor_position(const Link<TextView&, void>& rLink) override;
1482
1483     virtual bool can_move_cursor_with_up() const override;
1484
1485     virtual bool can_move_cursor_with_down() const override;
1486
1487     virtual void cut_clipboard() override;
1488
1489     virtual void copy_clipboard() override;
1490
1491     virtual void paste_clipboard() override;
1492
1493     virtual void set_alignment(TxtAlign eXAlign) override;
1494
1495     virtual int vadjustment_get_value() const override;
1496
1497     virtual void vadjustment_set_value(int value) override;
1498
1499     virtual int vadjustment_get_upper() const override;
1500
1501     virtual int vadjustment_get_lower() const override;
1502
1503     virtual int vadjustment_get_page_size() const override;
1504
1505     virtual bool has_focus() const override;
1506
1507     virtual ~SalInstanceTextView() override;
1508 };
1509
1510 struct SalInstanceTreeIter final : public weld::TreeIter
1511 {
1512     SalInstanceTreeIter(const SalInstanceTreeIter* pOrig)
1513         : iter(pOrig ? pOrig->iter : nullptr)
1514     {
1515     }
1516     SalInstanceTreeIter(SvTreeListEntry* pIter)
1517         : iter(pIter)
1518     {
1519     }
1520     virtual bool equal(const TreeIter& rOther) const override
1521     {
1522         return iter == static_cast<const SalInstanceTreeIter&>(rOther).iter;
1523     }
1524     SvTreeListEntry* iter;
1525 };
1526
1527 class SalInstanceTreeView : public SalInstanceWidget, public virtual weld::TreeView
1528 {
1529 protected:
1530     // owner for UserData
1531     std::vector<std::unique_ptr<OUString>> m_aUserData;
1532     VclPtr<SvTabListBox> m_xTreeView;
1533     SvLBoxButtonData m_aCheckButtonData;
1534     SvLBoxButtonData m_aRadioButtonData;
1535     // currently expanding parent that logically, but not currently physically,
1536     // contain placeholders
1537     o3tl::sorted_vector<SvTreeListEntry*> m_aExpandingPlaceHolderParents;
1538     // which columns should be custom rendered
1539     o3tl::sorted_vector<int> m_aCustomRenders;
1540     bool m_bTogglesAsRadio;
1541     int m_nSortColumn;
1542
1543     DECL_LINK(SelectHdl, SvTreeListBox*, void);
1544     DECL_LINK(DeSelectHdl, SvTreeListBox*, void);
1545     DECL_LINK(DoubleClickHdl, SvTreeListBox*, bool);
1546     DECL_LINK(ExpandingHdl, SvTreeListBox*, bool);
1547     DECL_LINK(EndDragHdl, HeaderBar*, void);
1548     DECL_LINK(HeaderBarClickedHdl, HeaderBar*, void);
1549     DECL_LINK(ToggleHdl, SvLBoxButtonData*, void);
1550     DECL_LINK(ModelChangedHdl, SvTreeListBox*, void);
1551     DECL_LINK(StartDragHdl, SvTreeListBox*, bool);
1552     DECL_STATIC_LINK(SalInstanceTreeView, FinishDragHdl, SvTreeListBox*, void);
1553     DECL_LINK(EditingEntryHdl, SvTreeListEntry*, bool);
1554     DECL_LINK(EditedEntryHdl, const IterString&, bool);
1555     DECL_LINK(VisibleRangeChangedHdl, SvTreeListBox*, void);
1556     DECL_LINK(CompareHdl, const SvSortData&, sal_Int32);
1557     DECL_LINK(PopupMenuHdl, const CommandEvent&, bool);
1558     DECL_LINK(TooltipHdl, SvTreeListEntry*, OUString);
1559     DECL_LINK(CustomRenderHdl, svtree_render_args, void);
1560     DECL_LINK(CustomMeasureHdl, svtree_measure_args, Size);
1561
1562     bool ExpandRow(const SalInstanceTreeIter& rIter);
1563
1564     // Each row has a cell for the expander image, (and an optional cell for a
1565     // checkbutton if enable_toggle_buttons has been called) which precede
1566     // index 0
1567     int to_internal_model(int col) const;
1568
1569     int to_external_model(int col) const;
1570
1571     bool IsDummyEntry(SvTreeListEntry* pEntry) const;
1572
1573     SvTreeListEntry* GetPlaceHolderChild(SvTreeListEntry* pEntry) const;
1574
1575     static void set_font_color(SvTreeListEntry* pEntry, const Color& rColor);
1576
1577     void AddStringItem(SvTreeListEntry* pEntry, const OUString& rStr, int nCol);
1578
1579     void do_insert(const weld::TreeIter* pParent, int pos, const OUString* pStr,
1580                    const OUString* pId, const OUString* pIconName,
1581                    const VirtualDevice* pImageSurface, bool bChildrenOnDemand, weld::TreeIter* pRet,
1582                    bool bIsSeparator);
1583
1584     void update_checkbutton_column_width(SvTreeListEntry* pEntry);
1585
1586     void InvalidateModelEntry(SvTreeListEntry* pEntry);
1587
1588     void do_set_toggle(SvTreeListEntry* pEntry, TriState eState, int col);
1589
1590     static TriState do_get_toggle(SvTreeListEntry* pEntry, int col);
1591     static bool do_get_sensitive(SvTreeListEntry* pEntry, int col);
1592
1593     TriState get_toggle(SvTreeListEntry* pEntry, int col) const;
1594
1595     void set_toggle(SvTreeListEntry* pEntry, TriState eState, int col);
1596
1597     bool get_text_emphasis(SvTreeListEntry* pEntry, int col) const;
1598
1599     void set_header_item_width(const std::vector<int>& rWidths);
1600
1601 public:
1602     SalInstanceTreeView(SvTabListBox* pTreeView, SalInstanceBuilder* pBuilder, bool bTakeOwnership);
1603
1604     virtual void connect_query_tooltip(const Link<const weld::TreeIter&, OUString>& rLink) override;
1605
1606     virtual void columns_autosize() override;
1607
1608     virtual void freeze() override;
1609
1610     virtual void thaw() override;
1611
1612     virtual void set_column_fixed_widths(const std::vector<int>& rWidths) override;
1613
1614     virtual void set_column_editables(const std::vector<bool>& rEditables) override;
1615
1616     virtual void set_centered_column(int nCol) override;
1617
1618     virtual int get_column_width(int nColumn) const override;
1619
1620     virtual OUString get_column_title(int nColumn) const override;
1621
1622     virtual void set_column_title(int nColumn, const OUString& rTitle) override;
1623
1624     virtual void set_column_custom_renderer(int nColumn, bool bEnable) override;
1625
1626     virtual void queue_draw() override;
1627
1628     virtual void show() override;
1629
1630     virtual void hide() override;
1631
1632     virtual void insert(const weld::TreeIter* pParent, int pos, const OUString* pStr,
1633                         const OUString* pId, const OUString* pIconName,
1634                         VirtualDevice* pImageSurface, bool bChildrenOnDemand,
1635                         weld::TreeIter* pRet) override;
1636
1637     virtual void insert_separator(int pos, const OUString& /*rId*/) override;
1638
1639     virtual void bulk_insert_for_each(
1640         int nSourceCount, const std::function<void(weld::TreeIter&, int nSourceIndex)>& func,
1641         const weld::TreeIter* pParent = nullptr, const std::vector<int>* pFixedWidths = nullptr,
1642         bool bGoingToSetText = false) override;
1643
1644     virtual void set_font_color(int pos, const Color& rColor) override;
1645
1646     virtual void set_font_color(const weld::TreeIter& rIter, const Color& rColor) override;
1647
1648     virtual void remove(int pos) override;
1649
1650     virtual int find_text(const OUString& rText) const override;
1651
1652     virtual int find_id(const OUString& rId) const override;
1653
1654     virtual void swap(int pos1, int pos2) override;
1655
1656     virtual void clear() override;
1657
1658     virtual int n_children() const override;
1659
1660     virtual int iter_n_children(const weld::TreeIter& rIter) const override;
1661
1662     virtual void select(int pos) override;
1663
1664     virtual int get_cursor_index() const override;
1665
1666     virtual void set_cursor(int pos) override;
1667
1668     virtual void scroll_to_row(int pos) override;
1669
1670     virtual bool is_selected(int pos) const override;
1671
1672     virtual void unselect(int pos) override;
1673
1674     virtual std::vector<int> get_selected_rows() const override;
1675
1676     OUString get_text(SvTreeListEntry* pEntry, int col) const;
1677
1678     virtual OUString get_text(int pos, int col = -1) const override;
1679
1680     void set_text(SvTreeListEntry* pEntry, const OUString& rText, int col);
1681
1682     virtual void set_text(int pos, const OUString& rText, int col = -1) override;
1683
1684     using SalInstanceWidget::set_sensitive;
1685     using SalInstanceWidget::get_sensitive;
1686
1687     void set_sensitive(SvTreeListEntry* pEntry, bool bSensitive, int col);
1688     bool get_sensitive(SvTreeListEntry* pEntry, int col) const;
1689
1690     virtual void set_sensitive(int pos, bool bSensitive, int col = -1) override;
1691
1692     virtual void set_sensitive(const weld::TreeIter& rIter, bool bSensitive, int col = -1) override;
1693
1694     virtual bool get_sensitive(int pos, int col) const override;
1695
1696     virtual bool get_sensitive(const weld::TreeIter& rIter, int col) const override;
1697
1698     virtual TriState get_toggle(int pos, int col = -1) const override;
1699
1700     virtual TriState get_toggle(const weld::TreeIter& rIter, int col = -1) const override;
1701
1702     virtual void enable_toggle_buttons(weld::ColumnToggleType eType) override;
1703
1704     virtual void set_toggle(int pos, TriState eState, int col = -1) override;
1705
1706     virtual void set_toggle(const weld::TreeIter& rIter, TriState eState, int col = -1) override;
1707
1708     virtual void set_clicks_to_toggle(int nToggleBehavior) override;
1709
1710     virtual void set_extra_row_indent(const weld::TreeIter& rIter, int nIndentLevel) override;
1711
1712     void set_text_emphasis(SvTreeListEntry* pEntry, bool bOn, int col = -1);
1713
1714     virtual void set_text_emphasis(const weld::TreeIter& rIter, bool bOn, int col) override;
1715
1716     virtual void set_text_emphasis(int pos, bool bOn, int col) override;
1717
1718     virtual bool get_text_emphasis(const weld::TreeIter& rIter, int col) const override;
1719
1720     virtual bool get_text_emphasis(int pos, int col) const override;
1721
1722     void set_text_align(SvTreeListEntry* pEntry, double fAlign, int col);
1723
1724     virtual void set_text_align(const weld::TreeIter& rIter, double fAlign, int col) override;
1725
1726     virtual void set_text_align(int pos, double fAlign, int col) override;
1727
1728     virtual void connect_editing(const Link<const weld::TreeIter&, bool>& rStartLink,
1729                                  const Link<const iter_string&, bool>& rEndLink) override;
1730
1731     virtual void start_editing(const weld::TreeIter& rIter) override;
1732
1733     virtual void end_editing() override;
1734
1735     void set_image(SvTreeListEntry* pEntry, const Image& rImage, int col);
1736
1737     virtual void set_image(int pos, const OUString& rImage, int col = -1) override;
1738
1739     virtual void set_image(int pos, const css::uno::Reference<css::graphic::XGraphic>& rImage,
1740                            int col = -1) override;
1741
1742     virtual void set_image(int pos, VirtualDevice& rImage, int col = -1) override;
1743
1744     virtual void set_image(const weld::TreeIter& rIter, const OUString& rImage,
1745                            int col = -1) override;
1746
1747     virtual void set_image(const weld::TreeIter& rIter,
1748                            const css::uno::Reference<css::graphic::XGraphic>& rImage,
1749                            int col = -1) override;
1750
1751     virtual void set_image(const weld::TreeIter& rIter, VirtualDevice& rImage,
1752                            int col = -1) override;
1753
1754     const OUString* getEntryData(int index) const;
1755
1756     virtual OUString get_id(int pos) const override;
1757
1758     void set_id(SvTreeListEntry* pEntry, const OUString& rId);
1759
1760     virtual void set_id(int pos, const OUString& rId) override;
1761
1762     virtual int get_selected_index() const override;
1763
1764     virtual OUString get_selected_text() const override;
1765
1766     virtual OUString get_selected_id() const override;
1767
1768     virtual std::unique_ptr<weld::TreeIter> make_iterator(const weld::TreeIter* pOrig
1769                                                           = nullptr) const override;
1770
1771     virtual void copy_iterator(const weld::TreeIter& rSource, weld::TreeIter& rDest) const override;
1772
1773     virtual bool get_selected(weld::TreeIter* pIter) const override;
1774
1775     virtual bool get_cursor(weld::TreeIter* pIter) const override;
1776
1777     virtual void set_cursor(const weld::TreeIter& rIter) override;
1778
1779     virtual bool get_iter_first(weld::TreeIter& rIter) const override;
1780
1781     bool get_iter_abs_pos(weld::TreeIter& rIter, int nPos) const;
1782
1783     virtual bool iter_next_sibling(weld::TreeIter& rIter) const override;
1784
1785     virtual bool iter_previous_sibling(weld::TreeIter& rIter) const override;
1786
1787     virtual bool iter_next(weld::TreeIter& rIter) const override;
1788
1789     virtual bool iter_previous(weld::TreeIter& rIter) const override;
1790
1791     virtual bool iter_children(weld::TreeIter& rIter) const override;
1792
1793     virtual bool iter_parent(weld::TreeIter& rIter) const override;
1794
1795     virtual void remove(const weld::TreeIter& rIter) override;
1796
1797     virtual void select(const weld::TreeIter& rIter) override;
1798
1799     virtual void scroll_to_row(const weld::TreeIter& rIter) override;
1800
1801     virtual void unselect(const weld::TreeIter& rIter) override;
1802
1803     virtual int get_iter_depth(const weld::TreeIter& rIter) const override;
1804
1805     virtual bool iter_has_child(const weld::TreeIter& rIter) const override;
1806
1807     virtual bool get_row_expanded(const weld::TreeIter& rIter) const override;
1808
1809     virtual bool get_children_on_demand(const weld::TreeIter& rIter) const override;
1810
1811     virtual void set_children_on_demand(const weld::TreeIter& rIter,
1812                                         bool bChildrenOnDemand) override;
1813
1814     virtual void expand_row(const weld::TreeIter& rIter) override;
1815
1816     virtual void collapse_row(const weld::TreeIter& rIter) override;
1817
1818     virtual OUString get_text(const weld::TreeIter& rIter, int col = -1) const override;
1819
1820     virtual void set_text(const weld::TreeIter& rIter, const OUString& rText,
1821                           int col = -1) override;
1822
1823     virtual OUString get_id(const weld::TreeIter& rIter) const override;
1824
1825     virtual void set_id(const weld::TreeIter& rIter, const OUString& rId) override;
1826
1827     virtual void enable_drag_source(rtl::Reference<TransferDataContainer>& rHelper,
1828                                     sal_uInt8 eDNDConstants) override;
1829
1830     virtual void set_selection_mode(SelectionMode eMode) override;
1831
1832     virtual void all_foreach(const std::function<bool(weld::TreeIter&)>& func) override;
1833
1834     virtual void selected_foreach(const std::function<bool(weld::TreeIter&)>& func) override;
1835
1836     virtual void visible_foreach(const std::function<bool(weld::TreeIter&)>& func) override;
1837
1838     virtual void connect_visible_range_changed(const Link<weld::TreeView&, void>& rLink) override;
1839
1840     virtual void remove_selection() override;
1841
1842     virtual bool is_selected(const weld::TreeIter& rIter) const override;
1843
1844     virtual int get_iter_index_in_parent(const weld::TreeIter& rIter) const override;
1845
1846     virtual int iter_compare(const weld::TreeIter& a, const weld::TreeIter& b) const override;
1847
1848     virtual void move_subtree(weld::TreeIter& rNode, const weld::TreeIter* pNewParent,
1849                               int nIndexInNewParent) override;
1850
1851     virtual int count_selected_rows() const override;
1852
1853     virtual int get_height_rows(int nRows) const override;
1854
1855     virtual void make_sorted() override;
1856
1857     virtual void set_sort_func(
1858         const std::function<int(const weld::TreeIter&, const weld::TreeIter&)>& func) override;
1859
1860     virtual void make_unsorted() override;
1861
1862     virtual void set_sort_order(bool bAscending) override;
1863
1864     virtual bool get_sort_order() const override;
1865
1866     virtual void set_sort_indicator(TriState eState, int col) override;
1867
1868     virtual TriState get_sort_indicator(int col) const override;
1869
1870     virtual int get_sort_column() const override;
1871
1872     virtual void set_sort_column(int nColumn) override;
1873
1874     SvTabListBox& getTreeView();
1875
1876     virtual bool get_dest_row_at_pos(const Point& rPos, weld::TreeIter* pResult, bool bDnDMode,
1877                                      bool bAutoScroll = true) override;
1878
1879     virtual void unset_drag_dest_row() override;
1880
1881     virtual tools::Rectangle get_row_area(const weld::TreeIter& rIter) const override;
1882
1883     virtual TreeView* get_drag_source() const override;
1884
1885     virtual int vadjustment_get_value() const override;
1886
1887     virtual void vadjustment_set_value(int nValue) override;
1888
1889     virtual void set_show_expanders(bool bShow) override;
1890
1891     virtual bool changed_by_hover() const override;
1892
1893     virtual ~SalInstanceTreeView() override;
1894 };
1895
1896 class SalInstanceExpander : public SalInstanceWidget, public virtual weld::Expander
1897 {
1898 private:
1899     VclPtr<VclExpander> m_xExpander;
1900
1901     DECL_LINK(ExpandedHdl, VclExpander&, void);
1902
1903 public:
1904     SalInstanceExpander(VclExpander* pExpander, SalInstanceBuilder* pBuilder, bool bTakeOwnership);
1905
1906     virtual void set_label(const OUString& rText) override;
1907
1908     virtual OUString get_label() const override;
1909
1910     virtual bool get_expanded() const override;
1911
1912     virtual void set_expanded(bool bExpand) override;
1913
1914     virtual bool has_focus() const override;
1915
1916     virtual void grab_focus() override;
1917
1918     virtual ~SalInstanceExpander() override;
1919 };
1920
1921 class SalInstanceIconView : public SalInstanceWidget, public virtual weld::IconView
1922 {
1923 protected:
1924     VclPtr<::IconView> m_xIconView;
1925
1926 private:
1927     // owner for UserData
1928     std::vector<std::unique_ptr<OUString>> m_aUserData;
1929
1930     DECL_LINK(SelectHdl, SvTreeListBox*, void);
1931     DECL_LINK(DeSelectHdl, SvTreeListBox*, void);
1932     DECL_LINK(DoubleClickHdl, SvTreeListBox*, bool);
1933     DECL_LINK(CommandHdl, const CommandEvent&, bool);
1934     DECL_LINK(TooltipHdl, SvTreeListEntry*, OUString);
1935     DECL_LINK(EntryAccessibleDescriptionHdl, SvTreeListEntry*, OUString);
1936     DECL_LINK(DumpImageHdl, const ::IconView::encoded_image_query&, bool);
1937
1938 public:
1939     SalInstanceIconView(::IconView* pIconView, SalInstanceBuilder* pBuilder, bool bTakeOwnership);
1940
1941     virtual int get_item_width() const override;
1942     virtual void set_item_width(int width) override;
1943
1944     virtual void freeze() override;
1945
1946     virtual void thaw() override;
1947
1948     virtual void insert(int pos, const OUString* pStr, const OUString* pId,
1949                         const OUString* pIconName, weld::TreeIter* pRet) override;
1950
1951     virtual void insert(int pos, const OUString* pStr, const OUString* pId,
1952                         const VirtualDevice* pIcon, weld::TreeIter* pRet) override;
1953
1954     virtual void insert_separator(int pos, const OUString* pId) override;
1955
1956     virtual void connect_query_tooltip(const Link<const weld::TreeIter&, OUString>& rLink) override;
1957
1958     virtual void
1959     connect_get_image(const Link<const weld::encoded_image_query&, bool>& rLink) override;
1960
1961     virtual OUString get_selected_id() const override;
1962
1963     virtual OUString get_selected_text() const override;
1964
1965     virtual int count_selected_items() const override;
1966
1967     virtual void select(int pos) override;
1968
1969     virtual void unselect(int pos) override;
1970
1971     virtual int n_children() const override;
1972
1973     virtual std::unique_ptr<weld::TreeIter> make_iterator(const weld::TreeIter* pOrig
1974                                                           = nullptr) const override;
1975
1976     virtual bool get_selected(weld::TreeIter* pIter) const override;
1977
1978     virtual bool get_cursor(weld::TreeIter* pIter) const override;
1979
1980     virtual void set_cursor(const weld::TreeIter& rIter) override;
1981
1982     virtual bool get_iter_first(weld::TreeIter& rIter) const override;
1983
1984     virtual bool iter_next_sibling(weld::TreeIter& rIter) const override;
1985
1986     virtual void scroll_to_item(const weld::TreeIter& rIter) override;
1987
1988     virtual void selected_foreach(const std::function<bool(weld::TreeIter&)>& func) override;
1989
1990     virtual OUString get_id(const weld::TreeIter& rIter) const override;
1991
1992     virtual OUString get_id(int pos) const override;
1993
1994     virtual void remove(int pos) override;
1995
1996     const OUString* getEntryData(int index) const;
1997
1998     virtual void set_image(int pos, VirtualDevice* rImage) override;
1999
2000     virtual void set_text(int pos, const OUString& rText) override;
2001
2002     virtual void set_id(int pos, const OUString& rId) override;
2003
2004     virtual OUString get_text(const weld::TreeIter& rIter) const override;
2005
2006     virtual tools::Rectangle get_rect(int pos) const override;
2007
2008     virtual void clear() override;
2009
2010     virtual ~SalInstanceIconView() override;
2011 };
2012
2013 class SalInstanceRadioButton : public SalInstanceButton, public virtual weld::RadioButton
2014 {
2015 private:
2016     VclPtr<::RadioButton> m_xRadioButton;
2017
2018     DECL_LINK(ToggleHdl, ::RadioButton&, void);
2019
2020 public:
2021     SalInstanceRadioButton(::RadioButton* pButton, SalInstanceBuilder* pBuilder,
2022                            bool bTakeOwnership);
2023
2024     virtual void set_active(bool active) override;
2025
2026     virtual bool get_active() const override;
2027
2028     virtual void set_image(VirtualDevice* pDevice) override;
2029
2030     virtual void set_image(const css::uno::Reference<css::graphic::XGraphic>& rImage) override;
2031
2032     virtual void set_from_icon_name(const OUString& rIconName) override;
2033
2034     virtual void set_inconsistent(bool /*inconsistent*/) override;
2035
2036     virtual bool get_inconsistent() const override;
2037
2038     virtual void set_label(const OUString& rText) override { SalInstanceButton::set_label(rText); }
2039
2040     virtual OUString get_label() const override { return SalInstanceButton::get_label(); }
2041
2042     virtual void set_label_wrap(bool wrap) override;
2043
2044     virtual ~SalInstanceRadioButton() override;
2045 };
2046
2047 class SalInstanceFrame : public SalInstanceContainer, public virtual weld::Frame
2048 {
2049 private:
2050     VclPtr<VclFrame> m_xFrame;
2051
2052 public:
2053     SalInstanceFrame(VclFrame* pFrame, SalInstanceBuilder* pBuilder, bool bTakeOwnership);
2054
2055     virtual void set_label(const OUString& rText) override;
2056
2057     virtual OUString get_label() const override;
2058
2059     virtual std::unique_ptr<weld::Label> weld_label_widget() const override;
2060 };
2061
2062 class SalInstanceMenuButton : public SalInstanceButton, public virtual weld::MenuButton
2063 {
2064 protected:
2065     VclPtr<::MenuButton> m_xMenuButton;
2066     sal_uInt16 m_nLastId;
2067
2068     DECL_LINK(MenuSelectHdl, ::MenuButton*, void);
2069     DECL_LINK(ActivateHdl, ::MenuButton*, void);
2070
2071 public:
2072     SalInstanceMenuButton(::MenuButton* pButton, SalInstanceBuilder* pBuilder, bool bTakeOwnership);
2073
2074     virtual void set_active(bool active) override;
2075
2076     virtual bool get_active() const override;
2077
2078     virtual void set_inconsistent(bool /*inconsistent*/) override;
2079
2080     virtual bool get_inconsistent() const override;
2081
2082     virtual void insert_item(int pos, const OUString& rId, const OUString& rStr,
2083                              const OUString* pIconName, VirtualDevice* pImageSurface,
2084                              TriState eCheckRadioFalse) override;
2085
2086     virtual void insert_separator(int pos, const OUString& rId) override;
2087
2088     virtual void set_item_sensitive(const OUString& rIdent, bool bSensitive) override;
2089
2090     virtual void remove_item(const OUString& rId) override;
2091
2092     virtual void clear() override;
2093
2094     virtual void set_item_active(const OUString& rIdent, bool bActive) override;
2095
2096     virtual void set_item_label(const OUString& rIdent, const OUString& rText) override;
2097
2098     virtual OUString get_item_label(const OUString& rIdent) const override;
2099
2100     virtual void set_item_visible(const OUString& rIdent, bool bShow) override;
2101
2102     virtual void set_popover(weld::Widget* pPopover) override;
2103
2104     virtual ~SalInstanceMenuButton() override;
2105 };
2106
2107 class SalInstancePopover : public SalInstanceContainer, public virtual weld::Popover
2108 {
2109 private:
2110     VclPtr<DockingWindow> m_xPopover;
2111
2112     DECL_LINK(PopupModeEndHdl, FloatingWindow*, void);
2113
2114     void ImplPopDown();
2115
2116 public:
2117     SalInstancePopover(DockingWindow* pPopover, SalInstanceBuilder* pBuilder, bool bTakeOwnership);
2118
2119     ~SalInstancePopover();
2120
2121     virtual void popup_at_rect(weld::Widget* pParent, const tools::Rectangle& rRect,
2122                                weld::Placement ePlace = weld::Placement::Under) override;
2123
2124     virtual void popdown() override;
2125
2126     virtual void resize_to_request() override;
2127 };
2128
2129 class SalInstanceBox : public SalInstanceContainer, public virtual weld::Box
2130 {
2131 private:
2132     VclPtr<VclBox> m_xBox;
2133
2134 public:
2135     SalInstanceBox(VclBox* pContainer, SalInstanceBuilder* pBuilder, bool bTakeOwnership);
2136     virtual void reorder_child(weld::Widget* pWidget, int nNewPosition) override;
2137     virtual void sort_native_button_order() override;
2138 };
2139
2140 class SalInstanceImage : public SalInstanceWidget, public virtual weld::Image
2141 {
2142 private:
2143     VclPtr<FixedImage> m_xImage;
2144
2145 public:
2146     SalInstanceImage(FixedImage* pImage, SalInstanceBuilder* pBuilder, bool bTakeOwnership);
2147
2148     virtual void set_from_icon_name(const OUString& rIconName) override;
2149
2150     virtual void set_image(VirtualDevice* pDevice) override;
2151
2152     virtual void set_image(const css::uno::Reference<css::graphic::XGraphic>& rImage) override;
2153 };
2154
2155 class SalInstanceScrolledWindow : public SalInstanceContainer, public virtual weld::ScrolledWindow
2156 {
2157 private:
2158     VclPtr<VclScrolledWindow> m_xScrolledWindow;
2159     Link<ScrollBar*, void> m_aOrigVScrollHdl;
2160     Link<ScrollBar*, void> m_aOrigHScrollHdl;
2161     bool m_bUserManagedScrolling;
2162
2163     DECL_LINK(VscrollHdl, ScrollBar*, void);
2164     DECL_LINK(HscrollHdl, ScrollBar*, void);
2165
2166     static void customize_scrollbars(ScrollBar& rScrollBar, const Color& rButtonTextColor,
2167                                      const Color& rBackgroundColor, const Color& rShadowColor,
2168                                      const Color& rFaceColor);
2169
2170 public:
2171     SalInstanceScrolledWindow(VclScrolledWindow* pScrolledWindow, SalInstanceBuilder* pBuilder,
2172                               bool bTakeOwnership, bool bUserManagedScrolling);
2173
2174     virtual void hadjustment_configure(int value, int lower, int upper, int step_increment,
2175                                        int page_increment, int page_size) override;
2176     virtual int hadjustment_get_value() const override;
2177     virtual void hadjustment_set_value(int value) override;
2178     virtual int hadjustment_get_upper() const override;
2179     virtual void hadjustment_set_upper(int upper) override;
2180     virtual int hadjustment_get_page_size() const override;
2181     virtual void hadjustment_set_page_size(int size) override;
2182     virtual void hadjustment_set_page_increment(int size) override;
2183     virtual void hadjustment_set_step_increment(int size) override;
2184     virtual void set_hpolicy(VclPolicyType eHPolicy) override;
2185     virtual VclPolicyType get_hpolicy() const override;
2186
2187     virtual void vadjustment_configure(int value, int lower, int upper, int step_increment,
2188                                        int page_increment, int page_size) override;
2189     virtual int vadjustment_get_value() const override;
2190     virtual void vadjustment_set_value(int value) override;
2191     virtual int vadjustment_get_upper() const override;
2192     virtual void vadjustment_set_upper(int upper) override;
2193     virtual int vadjustment_get_lower() const override;
2194     virtual void vadjustment_set_lower(int lower) override;
2195     virtual int vadjustment_get_page_size() const override;
2196     virtual void vadjustment_set_page_size(int size) override;
2197     virtual void vadjustment_set_page_increment(int size) override;
2198     virtual void vadjustment_set_step_increment(int size) override;
2199
2200     virtual void set_vpolicy(VclPolicyType eVPolicy) override;
2201     virtual VclPolicyType get_vpolicy() const override;
2202     virtual int get_scroll_thickness() const override;
2203     virtual void set_scroll_thickness(int nThickness) override;
2204     virtual void customize_scrollbars(const Color& rBackgroundColor, const Color& rShadowColor,
2205                                       const Color& rFaceColor) override;
2206     virtual ~SalInstanceScrolledWindow() override;
2207 };
2208
2209 class SalInstanceLevelBar : public SalInstanceWidget, public virtual weld::LevelBar
2210 {
2211 private:
2212     VclPtr<::ProgressBar> m_xLevelBar;
2213
2214 public:
2215     SalInstanceLevelBar(::ProgressBar* pLevelBar, SalInstanceBuilder* pBuilder, bool bTakeOwnership)
2216         : SalInstanceWidget(pLevelBar, pBuilder, bTakeOwnership)
2217         , m_xLevelBar(pLevelBar)
2218     {
2219     }
2220
2221     virtual void set_percentage(double fPercentage) override
2222     {
2223         m_xLevelBar->SetValue(static_cast<sal_uInt16>(fPercentage));
2224     }
2225 };
2226
2227 class SalInstanceCalendar : public SalInstanceWidget, public virtual weld::Calendar
2228 {
2229 private:
2230     VclPtr<::Calendar> m_xCalendar;
2231
2232     DECL_LINK(SelectHdl, ::Calendar*, void);
2233     DECL_LINK(ActivateHdl, ::Calendar*, void);
2234
2235 public:
2236     SalInstanceCalendar(::Calendar* pCalendar, SalInstanceBuilder* pBuilder, bool bTakeOwnership)
2237         : SalInstanceWidget(pCalendar, pBuilder, bTakeOwnership)
2238         , m_xCalendar(pCalendar)
2239     {
2240         m_xCalendar->SetSelectHdl(LINK(this, SalInstanceCalendar, SelectHdl));
2241         m_xCalendar->SetActivateHdl(LINK(this, SalInstanceCalendar, ActivateHdl));
2242     }
2243
2244     virtual void set_date(const Date& rDate) override { m_xCalendar->SetCurDate(rDate); }
2245
2246     virtual Date get_date() const override { return m_xCalendar->GetFirstSelectedDate(); }
2247
2248     virtual ~SalInstanceCalendar() override
2249     {
2250         m_xCalendar->SetSelectHdl(Link<::Calendar*, void>());
2251         m_xCalendar->SetActivateHdl(Link<::Calendar*, void>());
2252     }
2253 };
2254
2255 class SalInstanceFormattedSpinButton : public SalInstanceEntry,
2256                                        public virtual weld::FormattedSpinButton
2257 {
2258 private:
2259     VclPtr<FormattedField> m_xButton;
2260     weld::EntryFormatter* m_pFormatter;
2261     Link<weld::Widget&, void> m_aLoseFocusHdl;
2262
2263     DECL_LINK(UpDownHdl, SpinField&, void);
2264     DECL_LINK(LoseFocusHdl, Control&, void);
2265
2266 public:
2267     SalInstanceFormattedSpinButton(FormattedField* pButton, SalInstanceBuilder* pBuilder,
2268                                    bool bTakeOwnership);
2269
2270     virtual void set_text(const OUString& rText) override;
2271
2272     virtual void connect_changed(const Link<weld::Entry&, void>& rLink) override;
2273
2274     virtual void connect_focus_out(const Link<weld::Widget&, void>& rLink) override;
2275
2276     virtual void SetFormatter(weld::EntryFormatter* pFormatter) override;
2277
2278     virtual void sync_value_from_formatter() override
2279     {
2280         // no-op for gen
2281     }
2282
2283     virtual void sync_range_from_formatter() override
2284     {
2285         // no-op for gen
2286     }
2287
2288     virtual void sync_increments_from_formatter() override
2289     {
2290         // no-op for gen
2291     }
2292
2293     virtual Formatter& GetFormatter() override;
2294
2295     virtual ~SalInstanceFormattedSpinButton() override;
2296 };
2297
2298 class SalInstanceVerticalNotebook : public SalInstanceWidget, public virtual weld::Notebook
2299 {
2300 private:
2301     VclPtr<VerticalTabControl> m_xNotebook;
2302     /// Constructed on-demand.
2303     mutable std::map<OUString, std::shared_ptr<SalInstanceContainer>> m_aPages;
2304
2305     DECL_LINK(DeactivatePageHdl, VerticalTabControl*, bool);
2306     DECL_LINK(ActivatePageHdl, VerticalTabControl*, void);
2307
2308 public:
2309     SalInstanceVerticalNotebook(VerticalTabControl* pNotebook, SalInstanceBuilder* pBuilder,
2310                                 bool bTakeOwnership);
2311
2312     virtual int get_current_page() const override;
2313
2314     virtual OUString get_page_ident(int nPage) const override;
2315
2316     virtual OUString get_current_page_ident() const override;
2317
2318     virtual int get_page_index(const OUString& rIdent) const override;
2319
2320     virtual weld::Container* get_page(const OUString& rIdent) const override;
2321
2322     virtual void set_current_page(int nPage) override;
2323
2324     virtual void set_current_page(const OUString& rIdent) override;
2325
2326     virtual void remove_page(const OUString& rIdent) override;
2327
2328     virtual void insert_page(const OUString& rIdent, const OUString& rLabel, int nPos) override;
2329
2330     virtual int get_n_pages() const override;
2331
2332     virtual void set_tab_label_text(const OUString& rIdent, const OUString& rText) override;
2333
2334     virtual OUString get_tab_label_text(const OUString& rIdent) const override;
2335
2336     virtual void set_show_tabs(bool /*bShow*/) override;
2337
2338     virtual ~SalInstanceVerticalNotebook() override;
2339 };
2340
2341 /* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */