gz/gui/Helpers.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2017 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
#ifndef GZ_GUI_HELPERS_HH_
#define GZ_GUI_HELPERS_HH_
 
#include <string>
 
#include "gz/gui/Enums.hh"
#include "gz/gui/Export.hh"
 
namespace gz::gui
{
    GZ_GUI_VISIBLE
    std::string humanReadable(const std::string &_key);
 
    GZ_GUI_VISIBLE
    std::string unitFromKey(const std::string &_key,
                            const std::string &_type = "");
 
    GZ_GUI_VISIBLE
    void rangeFromKey(const std::string &_key, double &_min, double &_max);
 
    GZ_GUI_VISIBLE
    StringType stringTypeFromKey(const std::string &_key);
 
    GZ_GUI_VISIBLE
    std::string uniqueFilePath(const std::string &_pathAndName,
                               const std::string &_extension);
 
    GZ_GUI_VISIBLE
    QStringList worldNames();
 
    GZ_GUI_VISIBLE
    std::string renderEngineName();
 
    GZ_GUI_VISIBLE
    const QString qmlQrcImportPath();
 
    template<class T>
    T findFirstByProperty(const QList<T> _list, const char *_key,
        QVariant _value)
    {
      if (nullptr == _key)
        return nullptr;
 
      for (const auto &w : _list)
      {
        if (nullptr == w)
          continue;
 
        if (w->property(_key) == _value)
          return w;
      }
      return nullptr;
    }
}  // namespace gz::gui
#endif  // GZ_GUI_HELPERS_HH_