load_resource.h
Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2012, Willow Garage, Inc.
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *
00008  *     * Redistributions of source code must retain the above copyright
00009  *       notice, this list of conditions and the following disclaimer.
00010  *     * Redistributions in binary form must reproduce the above copyright
00011  *       notice, this list of conditions and the following disclaimer in the
00012  *       documentation and/or other materials provided with the distribution.
00013  *     * Neither the name of the Willow Garage, Inc. nor the names of its
00014  *       contributors may be used to endorse or promote products derived from
00015  *       this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00018  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00021  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00022  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00023  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00024  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00025  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00026  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00027  * POSSIBILITY OF SUCH DAMAGE.
00028  */
00029 
00030 #ifndef RESOURCE_RETRIEVING_H_
00031 #define RESOURCE_RETRIEVING_H_
00032 
00033 #include <QPixmap>
00034 #include <QCursor>
00035 #include <QString>
00036 
00037 namespace rviz
00038 {
00039 
00040 // Helper functions to load resources based on their resource url,
00041 // e.g. "package://rviz/icons/package.png",
00042 // or "file:///home/user/.ros/config.yaml".
00043 
00044 /* @brief Try to load the pixmap url from disk or the cache.
00045  *        In case of a failure, the result will be an empty QPixmap.
00046  *        If fill_cache is set to true (default), the image will be
00047  *        stored in the cache after loading it from disk.
00048  */
00049 QPixmap loadPixmap( QString url, bool fill_cache=true );
00050 
00051 /* @brief Load the default cursor: an arrow.
00052  *        The fill_cache parameter is ignored.
00053  */
00054 QCursor getDefaultCursor( bool fill_cache=true );
00055 
00056 /* @brief Create a cursor using a shape in a file/url.
00057  *        In case of a failure, the result will be the default arrow cursor.
00058  *        If fill_cache is set to true (default), the image will be
00059  *        stored in the cache after loading it from disk.
00060  */
00061 QCursor makeIconCursor( QString icon_url, bool fill_cache=true );
00062 
00063 /* @brief Create a cursor using the shape in the icon QPixmap.
00064  *        If fill_cache is set to true (default), the image will be
00065  *        stored in the cache using \e cache_key.
00066  */
00067 QCursor makeIconCursor( QPixmap icon, QString cache_key="", bool fill_cache=true );
00068 
00069 
00070 }
00071 
00072 
00073 #endif /* RESOURCE_RETRIEVING_H_ */


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Thu Aug 27 2015 15:02:27