CommandLock.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Design
File: CommandLock
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/TranslatedString.h>
#include <NDEVR/UUID.h>
namespace NDEVR
{
    class WLock;
    class DesignCommandManager;
    /**--------------------------------------------------------------------------------------------------
    \brief Used with DesignObjectLookups to lock the application for a critical process. Will potentially
        display the title to the end user.
    **/
    class NDEVR_DESIGN_API CommandLockObject
    {
    public:
        CommandLockObject(DesignCommandManager* manager, const TranslatedString& title = TranslatedString());
        ~CommandLockObject();
        void tryLock();
        void lock();
        void unlock();
        void setTitle(const TranslatedString& title);
        void setHint(const TranslatedString& title);
        const TranslatedString hint() const;
        const TranslatedString title() const;
        bool isLocked() const;
    protected:
        //WLock* m_lock;
        UUID m_id;
        DesignCommandManager* m_manager;
        TranslatedString m_title;
        TranslatedString m_hint;
    };
}