UserManualCmd.hh

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    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.
 */
/**
 * @file UserManualCmd.hh
 *
 * Declaration of UserManualCmd class.
 *
 * @author Tommi Rantanen 2004 (tommi.rantanen-no.spam-tut.fi)
 */
 
#ifndef TTA_USER_MANUAL_CMD_HH
#define TTA_USER_MANUAL_CMD_HH
 
#include "GUICommand.hh"
 
/**
 * wxCommand for displaying the TCE manual in the system's default PDF viewer.
 */
class UserManualCmd : public GUICommand {
public:
    UserManualCmd();
    virtual ~UserManualCmd();
    virtual bool Do();
    virtual int id() const;
    virtual UserManualCmd* create() const;
    virtual std::string icon() const;
    virtual std::string shortName() const;
    virtual bool isEnabled();
 
    /// Command name string.
    static const std::string COMMAND_NAME;
    /// Short version of the command name string.
    static const std::string COMMAND_SHORT_NAME;
    /// Command icon file name.
    static const std::string COMMAND_ICON;
    /// Command ID.
    static const int COMMAND_ID;
 
private:
    bool askFromUser();
 
    /// Tells if the singleton mime types manager has already been initialized.
    static bool mimeTypesManagerInitialized_;
};
 
#endif