MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

ResourcePolicy::BacklightResource Class Reference

The BacklightResource is used by applications wanting to control the backlight. More...

Inherits ResourcePolicy::Resource.

Collaboration diagram for ResourcePolicy::BacklightResource:
Collaboration graph
[legend]

List of all members.

Public Member Functions

  BacklightResource ()
  The constructor.
  BacklightResource (const BacklightResource &other)
  The copy constructor.
virtual  ~BacklightResource ()
  The destructor.
virtual ResourceType  type () const
bool  isOptional () const
  Whether or not this resource is optional, in that it does not need to be available for the set to be acquired.
void  setOptional (bool resourceIsOptional=true)
  Sets the resource to be optional or mandatory.
bool  isGranted () const
  Whether or not the resource to be shared.

Detailed Description

The BacklightResource is used by applications wanting to control the backlight.


Constructor & Destructor Documentation

ResourcePolicy::BacklightResource::BacklightResource ( const BacklightResource other  ) 

The copy constructor.

Parameters:
other  The resource to copy from

Member Function Documentation

virtual ResourceType ResourcePolicy::BacklightResource::type (  )  const [virtual]
Returns:
The resource type

Implements ResourcePolicy::Resource.

bool ResourcePolicy::Resource::isOptional (  )  const [inherited]

Whether or not this resource is optional, in that it does not need to be available for the set to be acquired.

Returns:
true when this resource is optional
void ResourcePolicy::Resource::setOptional ( bool  resourceIsOptional = true  )  [inherited]

Sets the resource to be optional or mandatory.

Parameters:
resourceIsOptional  This optional parameter is true by default. The default, true, results in the resource becoming optional. When it is set to false the resource becomes mandatory.
bool ResourcePolicy::Resource::isGranted (  )  const [inherited]

Whether or not the resource to be shared.

If it is shared then other programs are allowed to share this resource.

Returns:
true when this resource is shared

Copyright (C) 2011 Nokia Corporation.
LGPL This file is part of libresourceqt
MeeGo 1.2 Harmattan API