NDEVR
API Documentation
CustomDockButton.h
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2019, NDEVR LLC
3tyler.parke@ndevr.org
4 __ __ ____ _____ __ __ _______
5 | \ | | | __ \ | ___|\ \ / / | __ \
6 | \ | | | | \ \ | |___ \ \ / / | |__) |
7 | . \| | | |__/ / | |___ \ V / | _ /
8 | |\ |_|_____/__|_____|___\_/____| | \ \
9 |__| \__________________________________| \__\
10
11Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12Licensee a limited, non-exclusive, non-transferable, royalty-free license
13(without the right to sublicense) to use the API solely for the purpose of
14Licensee's internal development efforts to develop applications for which
15the API was provided.
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25DEALINGS IN THE SOFTWARE.
26
27Library: Widgets
28File: CustomDockButton
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include "DLLInfo.h"
34#include <NDEVR/DockItem.h>
35#include <functional>
36class QIcon;
37class QString;
38class QLabel;
39
40
41namespace NDEVR
42{
44 class SectionWidget;
45 class SectionContent;
46 class SectionIconTab;
47 class FloatingWidget;
48 class TranslatedString;
49 class Button;
55 class NDEVR_WIDGETS_API CustomDockButton : public DockItem
56 {
57 Q_OBJECT
58 public:
65 explicit CustomDockButton(const TranslatedString& name, RibbonArea ribbon_area, ContainerWidgetBase* container = nullptr);
73 explicit CustomDockButton(const TranslatedString& name, const std::function<void(SectionContent*)>& callback, RibbonArea ribbon_area, ContainerWidgetBase* container = nullptr);
80 explicit CustomDockButton(const TranslatedString& name, const std::function<void(SectionContent*)>& callback, ContainerWidgetBase* container = nullptr);
81 virtual ~CustomDockButton();
87 void showButton(bool show_dock, SectionWidget* section);
96 virtual void setupDialogButton(Button* button);
101 void setCallback(const std::function<void(SectionContent*)>& callback);
106 const std::function<void(SectionContent*)>& callback();
107 private:
111 virtual void createSectionContent() override;
112 signals:
117 private slots:
118 void onCloseButtonClicked();
119 void _CustomMenuRequested(const QPoint& pos);
120 private:
121 std::function<void(SectionContent*)> m_callback;
122 };
123}
A core widget that allows the user to click one of many button types.
Definition Button.h:68
The root class that manages a series of SectionContent that can share the same space or lay out in va...
void setCallback(const std::function< void(SectionContent *)> &callback)
Sets the callback function to invoke when the button is activated.
void closedSignal()
Emitted when the dock button is closed.
virtual void createSectionContent() override
Creates the SectionContent used by this dock button.
CustomDockButton(const TranslatedString &name, const std::function< void(SectionContent *)> &callback, RibbonArea ribbon_area, ContainerWidgetBase *container=nullptr)
Constructs a custom dock button with a name, callback, and ribbon area.
virtual void setupDialogButton(Button *button)
Sets up the visual appearance and behavior of the dialog button.
void showButton(bool show_dock, SectionWidget *section)
Shows or hides the dock button within the given section widget.
void removeButton()
Removes the button from its current section widget.
CustomDockButton(const TranslatedString &name, const std::function< void(SectionContent *)> &callback, ContainerWidgetBase *container=nullptr)
Constructs a custom dock button with a name and callback.
const std::function< void(SectionContent *)> & callback()
Returns the callback function associated with this button.
CustomDockButton(const TranslatedString &name, RibbonArea ribbon_area, ContainerWidgetBase *container=nullptr)
Constructs a custom dock button with a name and ribbon area.
SectionWidget * section() const
Returns the section widget that currently contains this dock item.
DockItem(RibbonArea ribbon_area, ContainerWidgetBase *container=nullptr)
Constructs a DockItem with a preferred ribbon area and optional container.
ContainerWidgetBase * container() const
Returns the container widget that owns this dock item.
Used with the NDEVR API Widget Docking system for widgets that are floating.
The core container for objects using the NDEVR API Widget Docking system.
Provides a tab that contains an icon and some buttons used for either a tab if the section content is...
SectionWidget manages multiple instances of SectionContent.
Any text displayed to the user should be defined as a TranslatedString which allows the program to lo...
The primary namespace for the NDEVR SDK.
RibbonArea
Requests a ribbon or tab area to be in a certain location and orientation relative to another widget.
Definition RibbonArea.h:71