NDEVR
API Documentation
ButtonDialog.h
1
/*--------------------------------------------------------------------------------------------
2
Copyright (c) 2019, NDEVR LLC
3
tyler.parke@ndevr.org
4
__ __ ____ _____ __ __ _______
5
| \ | | | __ \ | ___|\ \ / / | __ \
6
| \ | | | | \ \ | |___ \ \ / / | |__) |
7
| . \| | | |__/ / | |___ \ V / | _ /
8
| |\ |_|_____/__|_____|___\_/____| | \ \
9
|__| \__________________________________| \__\
10
11
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12
Licensee a limited, non-exclusive, non-transferable, royalty-free license
13
(without the right to sublicense) to use the API solely for the purpose of
14
Licensee's internal development efforts to develop applications for which
15
the API was provided.
16
17
The above copyright notice and this permission notice shall be included in all
18
copies or substantial portions of the Software.
19
20
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25
DEALINGS IN THE SOFTWARE.
26
27
Library: Widgets
28
File: ButtonDialog
29
Included in API: True
30
Author(s): Tyler Parke
31
*-----------------------------------------------------------------------------------------**/
32
#pragma once
33
#include "DLLInfo.h"
34
#include <NDEVR/Buffer.h>
35
#include <QPointer>
36
namespace
NDEVR
37
{
38
class
Button
;
39
struct
PopupInfo
;
46
class
NDEVR_WIDGETS_API
ButtonDialog
47
{
48
public
:
52
virtual
~ButtonDialog
();
57
virtual
void
addButton
(
Button
* button);
62
virtual
void
removeButton
(
Button
* button);
67
virtual
void
setButtonsChecked
(
bool
check);
72
PopupInfo
buttonDialogBestPopupInfo
()
const
;
76
virtual
void
onCheckedClick
();
77
protected
:
78
bool
m_should_be_checked
=
false
;
79
QPointer<Button>
m_last_pressed
;
80
Buffer<QPointer<Button>
>
m_buttons
;
81
};
82
}
Buffer
The equivelent of std::vector but with a bit more control.
Definition
Buffer.hpp:58
ButtonDialog
Typically used for dialogs which have any number of buttons associated with it that are toggled on wh...
Definition
ButtonDialog.h:47
ButtonDialog::onCheckedClick
virtual void onCheckedClick()
Called when an associated button is clicked while already checked, typically to toggle visibility.
ButtonDialog::setButtonsChecked
virtual void setButtonsChecked(bool check)
Sets the checked state of all associated buttons.
ButtonDialog::m_buttons
Buffer< QPointer< Button > > m_buttons
All buttons associated with this dialog.
Definition
ButtonDialog.h:80
ButtonDialog::buttonDialogBestPopupInfo
PopupInfo buttonDialogBestPopupInfo() const
Returns the best PopupInfo configuration based on the last pressed button's position.
ButtonDialog::removeButton
virtual void removeButton(Button *button)
Removes a previously associated button.
ButtonDialog::addButton
virtual void addButton(Button *button)
Adds a button that controls the visibility of the dialog.
ButtonDialog::~ButtonDialog
virtual ~ButtonDialog()
Virtual destructor.
ButtonDialog::m_last_pressed
QPointer< Button > m_last_pressed
The most recently pressed button, used for popup positioning.
Definition
ButtonDialog.h:79
ButtonDialog::m_should_be_checked
bool m_should_be_checked
Whether the associated buttons should be in the checked state.
Definition
ButtonDialog.h:78
Button
A core widget that allows the user to click one of many button types.
Definition
Button.h:68
NDEVR
The primary namespace for the NDEVR SDK.
Definition
ArialTileFetcherModule.h:35
PopupInfo
Class which is used to pass arguments and requests for creating a popup dialog or widget.
Definition
PopupInfo.h:16
Widgets
Headers
ButtonDialog.h
NDEVR.org