StelObjectModule.hpp

/*
 * Stellarium
 * Copyright (C) 2006 Fabien Chereau
 * Copyright (C) 2016 Marcos Cardinot
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA  02110-1335, USA.
 */

#ifndef _STELOBJECTMODULE_HPP_
#define _STELOBJECTMODULE_HPP_

#include "StelModule.hpp"
#include "StelObjectType.hpp"
#include "VecMath.hpp"

#include <QList>
#include <QString>
#include <QStringList>

class StelObjectModule : public StelModule
{
    Q_OBJECT
public:
    StelObjectModule();
    ~StelObjectModule();
    
    virtual QList<StelObjectP> searchAround(const Vec3d& v, double limitFov, const StelCore* core) const = 0;
    
    virtual StelObjectP searchByNameI18n(const QString& nameI18n) const = 0;

    virtual StelObjectP searchByName(const QString& name) const = 0;

    virtual QStringList listMatchingObjects(const QString& objPrefix, int maxNbItem=5, bool useStartOfWords=false, bool inEnglish=false) const;

    virtual QStringList listAllObjects(bool inEnglish) const = 0;

    virtual QStringList listAllObjectsByType(const QString& objType, bool inEnglish) const;

    virtual QString getName() const = 0;

    bool matchObjectName(const QString& objName, const QString& objPrefix, bool useStartOfWords) const;
};

#endif // _STELOBJECTMODULE_HPP_