summaryrefslogtreecommitdiff
path: root/libresourceqt/include/qt4/policy/resource.h
diff options
context:
space:
mode:
authorWolf Bergenheim <ext-wolf.2.bergenheim@nokia.com>2010-03-10 14:32:07 +0200
committerWolf Bergenheim <ext-wolf.2.bergenheim@nokia.com>2010-03-10 14:32:07 +0200
commitff1e1a228971c2412ad21693e558bbdcaaeaba77 (patch)
treee7c8ca9a0c6913970b078303092140c78075db3b /libresourceqt/include/qt4/policy/resource.h
parent53060a6e6e0b1920fb18f9be1e67eec21f62f9fa (diff)
downloadlibresourceqt-ff1e1a228971c2412ad21693e558bbdcaaeaba77.tar.gz
Updated documentation
Diffstat (limited to 'libresourceqt/include/qt4/policy/resource.h')
-rw-r--r--libresourceqt/include/qt4/policy/resource.h34
1 files changed, 20 insertions, 14 deletions
diff --git a/libresourceqt/include/qt4/policy/resource.h b/libresourceqt/include/qt4/policy/resource.h
index 434f3dd..4c18408 100644
--- a/libresourceqt/include/qt4/policy/resource.h
+++ b/libresourceqt/include/qt4/policy/resource.h
@@ -5,24 +5,27 @@
namespace ResourcePolicy
{
+/**
+ * This enumeration represents the resources which can be reserved.
+ * \see ResourcePolicy::ResourceSet::AddResource() for info on how to reserve
+ * resources.
+ */
enum ResourceType {
- AudioPlaybackType = 0,
- VideoPlaybackType,
- AudioRecorderType,
- VideoRecorderType,
- VibraType,
- LedsType,
- BacklightType,
- SystemButtonType,
- LockButtonType,
- ScaleButtonType,
- SnapButtonType,
+ 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,
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.
@@ -30,7 +33,6 @@ class ResourceSet;
class Resource
{
public:
- friend class ResourceSet;
/**
* Whether or not this resource is optional, in that it doesn't need to
* be available for the set to be acquired.
@@ -51,6 +53,10 @@ public:
*/
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: