load_resource.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012, Willow Garage, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Willow Garage, Inc. nor the names of its
14  * contributors may be used to endorse or promote products derived from
15  * this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #ifndef RESOURCE_RETRIEVING_H_
31 #define RESOURCE_RETRIEVING_H_
32 
33 #include <QPixmap>
34 #include <QCursor>
35 #include <QString>
36 
37 namespace rviz
38 {
39 // Helper functions to load resources based on their resource url,
40 // e.g. "package://rviz/icons/package.png",
41 // or "file:///home/user/.ros/config.yaml".
42 
43 /* @brief Try to load the pixmap url from disk or the cache.
44  * In case of a failure, the result will be an empty QPixmap.
45  * If fill_cache is set to true (default), the image will be
46  * stored in the cache after loading it from disk.
47  */
48 QPixmap loadPixmap(QString url, bool fill_cache = true);
49 
50 /* @brief Load the default cursor: an arrow.
51  * The fill_cache parameter is ignored.
52  */
53 QCursor getDefaultCursor(bool fill_cache = true);
54 
55 /* @brief Create a cursor using a shape in a file/url.
56  * In case of a failure, the result will be the default arrow cursor.
57  * If fill_cache is set to true (default), the image will be
58  * stored in the cache after loading it from disk.
59  */
60 QCursor makeIconCursor(QString icon_url, bool fill_cache = true);
61 
62 /* @brief Create a cursor using the shape in the icon QPixmap.
63  * If fill_cache is set to true (default), the image will be
64  * stored in the cache using \e cache_key.
65  */
66 QCursor makeIconCursor(QPixmap icon, QString cache_key = "", bool fill_cache = true);
67 
68 
69 } // namespace rviz
70 
71 
72 #endif /* RESOURCE_RETRIEVING_H_ */
rviz::makeIconCursor
QCursor makeIconCursor(QString url, bool fill_cache)
Definition: load_resource.cpp:101
rviz::getDefaultCursor
QCursor getDefaultCursor(bool)
Definition: load_resource.cpp:96
rviz::loadPixmap
QPixmap loadPixmap(QString url, bool fill_cache)
Definition: load_resource.cpp:65

rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Sat May 27 2023 02:06:24