summaryrefslogtreecommitdiff log msg author committer range
blob: a4d3c0a8177f0f7c05c8ccde0b4b6e34f43787ef (plain)
 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144  /************************************************************************* This file is part of libresourceqt Copyright (C) 2010 Nokia Corporation. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation version 2.1 of the License. This library 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 Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *************************************************************************/ /** * @file resource.h * @brief Declaration of ResourcePolicy::Resource and * ResourcePolicy::ResourceType * * @copyright Copyright (C) 2010 Nokia Corporation. * @author Wolf Bergenheim * \par License * @license LGPL * This file is part of libresourceqt * \par * Copyright (C) 2010 Nokia Corporation. * \par * This library is free software; you can redistribute * it and/or modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation * version 2.1 of the License. * \par * This library 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 * Lesser General Public License for more details. * \par * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 * USA. */ #ifndef RESOURCE_H #define RESOURCE_H #include namespace ResourcePolicy { /** * This enumeration represents the resources which can be reserved. * \see ResourcePolicy::ResourceSet for info on how to reserve resources. */ enum ResourceType { AudioPlaybackType = 0, ///< For audio playback VideoPlaybackType, ///< For video playback AudioRecorderType, ///< For audio recording (using of the microphone) VideoRecorderType, ///< For video recording (using the camera) VibraType, ///< For Vibra LedsType, ///< For LEDs BacklightType, ///< For the backlight (of the display) SystemButtonType, ///< For the system (power) button LockButtonType, ///< For the lock button ScaleButtonType, ///< The scale (zoom) button SnapButtonType, ///< Use this if you are a camera application LensCoverType, HeadsetButtonsType, ///< Use this to reserve the headset buttons NumberOfTypes }; class ResourceSet; /** * This class is the super class for all resources. It represents a generic * \ref Resource. The type specific resource classes should be used. */ class Resource { friend class ResourceSet; public: /** * Whether or not this resource is optional, in that it doesn't need to * be available for the set to be acquired. * \return true when this resource is optional. */ bool isOptional() const; /** * Set the resource to be optional or mandatory. * \param resourceIsOptional This optional parameter defaults to true. * The default, true, results in the resource becoming optional. When it * is set to false the resource becomes mandatory. */ void setOptional(bool resourceIsOptional = true); /** * Whether or not the resource to be shared. If it is shared then other * programs are allowed to share this resource. * \return true when this resource is shared. */ bool isGranted() const; /** * Use this method to check for the type of Resource * \return The ResourceType associated to this resource */ virtual ResourceType type() const = 0; virtual ~Resource(); protected: Resource(); Resource(const Resource &other); /** * \internal * This holds the type of the resource. */ ResourceType resourceType; /** * \internal * This is true when this resource is optional. * \sa isOptional * \sa setOptional */ bool optional; /** * \internal * This is just a unique identifier for the resource. */ quint32 identifier; private: void setGranted(); void unsetGranted(); bool granted; }; } #endif