diff options
author | Wolf Bergenheim <ext-wolf.2.bergenheim@nokia.com> | 2010-10-20 14:07:00 +0300 |
---|---|---|
committer | Wolf Bergenheim <ext-wolf.2.bergenheim@nokia.com> | 2010-10-20 14:07:00 +0300 |
commit | 08812af10c43426ef521abbdc68b91f8ba9cfb62 (patch) | |
tree | 990c819b0fe08a8a5a28dda1d5cd990f1a8f04c5 /libresourceqt/include/qt4 | |
parent | b33025a09f6fc4ad9f4c60c71fd629b34e0ba521 (diff) |
Updated documentation and bumped version
Diffstat (limited to 'libresourceqt/include/qt4')
-rw-r--r-- | libresourceqt/include/qt4/policy/resource.h | 6 | ||||
-rw-r--r-- | libresourceqt/include/qt4/policy/resources.h | 194 |
2 files changed, 193 insertions, 7 deletions
diff --git a/libresourceqt/include/qt4/policy/resource.h b/libresourceqt/include/qt4/policy/resource.h index f77ac31..7a54ab9 100644 --- a/libresourceqt/include/qt4/policy/resource.h +++ b/libresourceqt/include/qt4/policy/resource.h @@ -51,9 +51,9 @@ enum ResourceType { 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. -*/ + * 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; diff --git a/libresourceqt/include/qt4/policy/resources.h b/libresourceqt/include/qt4/policy/resources.h index cf5efa3..d8c2e5e 100644 --- a/libresourceqt/include/qt4/policy/resources.h +++ b/libresourceqt/include/qt4/policy/resources.h @@ -28,127 +28,313 @@ USA. namespace ResourcePolicy { +/** + * The AudioRecorderResource class represents the audio recorder device. + */ class AudioRecorderResource: public Resource { public: + /** + * The constructor. + */ AudioRecorderResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ AudioRecorderResource(const AudioRecorderResource &other); + /** + * The destructor. + */ virtual ~AudioRecorderResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; -private: - QString group; - quint32 pid; - QString stream; }; +/** + * The BacklightResource is used by applications wanting to control the + * backlight + */ class BacklightResource: public Resource { public: + /** + * The constructor. + */ BacklightResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ BacklightResource(const BacklightResource &other); + /** + * The destructor. + */ virtual ~BacklightResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; +/** + * Resource to be used when the application wants to fiddle with the leds. + */ class LedsResource: public Resource { public: + /** + * The constructor. + */ LedsResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ LedsResource(const LedsResource &other); + /** + * The destructor. + */ virtual ~LedsResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; +/** + * Resource to be used when the application wants to use the vibra. + */ class VibraResource: public Resource { public: + /** + * The constructor. + */ VibraResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ VibraResource(const VibraResource &other); + /** + * The destructor. + */ virtual ~VibraResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; +/** + * Resource to be used when the application wants to record video. + */ class VideoRecorderResource: public Resource { public: + /** + * The constructor. + */ VideoRecorderResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ VideoRecorderResource(const VideoRecorderResource &other); + /** + * The destructor. + */ virtual ~VideoRecorderResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; +/** + * Resource to be used when the application wants to render video with the + * DSP decoder to render the viewfinder. + */ class VideoResource: public Resource { public: + /** + * The constructor. + */ VideoResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ VideoResource(const VideoResource &other); + /** + * The destructor. + */ virtual ~VideoResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; +/** + * Resource to be used when the application wants to control the system button. + */ class SystemButtonResource: public Resource { public: + /** + * The constructor. + */ SystemButtonResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ SystemButtonResource(const SystemButtonResource &other); + /** + * The destructor. + */ virtual ~SystemButtonResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; class LockButtonResource: public Resource { public: + /** + * The constructor. + */ LockButtonResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ LockButtonResource(const LockButtonResource &other); + /** + * The destructor. + */ virtual ~LockButtonResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; +/** + * Resource to be used when the application wants to control + * the volume/scale button. + */ class ScaleButtonResource: public Resource { public: + /** + * The constructor. + */ ScaleButtonResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ ScaleButtonResource(const ScaleButtonResource &other); + /** + * The destructor. + */ virtual ~ScaleButtonResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; +/** + * Resource to be used when the application wants to take still pictures. + */ class SnapButtonResource: public Resource { public: + /** + * The constructor. + */ SnapButtonResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ SnapButtonResource(const SnapButtonResource &other); + /** + * The destructor. + */ virtual ~SnapButtonResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; class LensCoverResource: public Resource { public: + /** + * The constructor. + */ LensCoverResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ LensCoverResource(const LensCoverResource &other); + /** + * The destructor. + */ virtual ~LensCoverResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; +/** + * Resource to be used when the application wants to control the + * headset buttons. + */ class HeadsetButtonsResource: public Resource { public: + /** + * The constructor. + */ HeadsetButtonsResource(); + /** + * The copy constructor. + * \param other The resource to copy from + */ HeadsetButtonsResource(const HeadsetButtonsResource &other); + /** + * The destructor. + */ virtual ~HeadsetButtonsResource(); + /** + * \return the resource type + */ virtual ResourceType type() const; }; |