summaryrefslogtreecommitdiff
path: root/libopie2
Unidiff
Diffstat (limited to 'libopie2') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/opiecore/device/odevice.cpp64
1 files changed, 60 insertions, 4 deletions
diff --git a/libopie2/opiecore/device/odevice.cpp b/libopie2/opiecore/device/odevice.cpp
index 2b10034..ec861ee 100644
--- a/libopie2/opiecore/device/odevice.cpp
+++ b/libopie2/opiecore/device/odevice.cpp
@@ -344,9 +344,14 @@ bool ODevice::setDisplayBrightness ( int p)
344} 344}
345 345
346/** 346/**
347* @return returns the number of steppings on the brightness slider 347 *
348* in the Light-'n-Power settings. 348 * @return Returns the number of steppings on the brightness slider
349*/ 349 * in the Light-'n-Power settings. Values smaller zero and bigger
350 * than 255 do not make sense.
351 *
352 * \sa QSlider::setLineStep
353 * \sa QSlider::setPageStep
354 */
350int ODevice::displayBrightnessResolution() const 355int ODevice::displayBrightnessResolution() const
351{ 356{
352 return 16; 357 return 16;
@@ -711,14 +716,24 @@ void ODevice::remapHeldAction ( int button, const OQCopMessage &action )
711 716
712 QCopEnvelope ( "QPE/System", "deviceButtonMappingChanged()" ); 717 QCopEnvelope ( "QPE/System", "deviceButtonMappingChanged()" );
713} 718}
719
720/**
721 * @internal
722 */
714void ODevice::virtual_hook(int, void* ){ 723void ODevice::virtual_hook(int, void* ){
715 724
716} 725}
717 726
718/** 727/**
728 * \brief Send a QCOP Message before suspending
729 *
719 * Sends a QCOP message to channel QPE/System 730 * Sends a QCOP message to channel QPE/System
720 * with the message "aboutToSuspend()" if this 731 * with the message "aboutToSuspend()" if this
721 * is the windowing server 732 * is the windowing server.
733 *
734 * Call this in your custom \sa suspend() Method
735 * before going to suspend.
736 *
722 */ 737 */
723void ODevice::sendSuspendmsg() 738void ODevice::sendSuspendmsg()
724{ 739{
@@ -758,6 +773,12 @@ void ODevice::remPreHandler(QWSServer::KeyboardFilter*aFilter)
758 Opie::Core::OKeyFilter::inst()->remPreHandler(aFilter); 773 Opie::Core::OKeyFilter::inst()->remPreHandler(aFilter);
759} 774}
760 775
776
777/**
778 * @internal
779 *
780 * @see changeMixerForAlarm
781 */
761void ODevice::playingStopped() { 782void ODevice::playingStopped() {
762 const_cast<QObject*>(sender())->disconnect( this ); 783 const_cast<QObject*>(sender())->disconnect( this );
763#ifndef QT_NO_SOUND 784#ifndef QT_NO_SOUND
@@ -768,6 +789,41 @@ void ODevice::playingStopped() {
768#endif 789#endif
769} 790}
770 791
792
793/**
794 * \brief Change the Volume for the Alarm and set it back after playing is finished
795 *
796 * If you play an Alarm Sound you might want to change the Mixer to
797 * full volume and ignore the user setting. After it \sa Sound::isFinished
798 * you would turn the volume back to the user preference.
799 * The problem is that we used to enter the event loop while waiting
800 * for the sound to be finished triggering all kind of reentrance
801 * problems what a library shouldn't introduce.
802 * Instead of manually waiting for the sound to be finished use
803 * this Method and it will automatically restore the Mixer to
804 * the user configuration after the sound finished playing.
805 *
806 * Note: The onwership of \param snd is not transfered and playing
807 * is not started in this method. If 'snd' gets deleted before
808 * playing is finished the volume doesn't get set back to
809 * the user preference!
810 *
811 * \code
812 * static Sound snd("alarm");
813 * if(!snd.isFinished())
814 * return;
815 *
816 * changeMixerForAlarm( my_channel, "/dev/mixer", &snd );
817 * snd.play()
818 * \endcode
819 *
820 *
821 *
822 * @param mixer The mixer number/channel to use
823 * @param file The file name. If you convert from QString use QFile::encodeName
824 * @param snd The sound to wait for finishing
825 *
826 */
771void ODevice::changeMixerForAlarm( int mixer, const char* file, Sound *snd ) { 827void ODevice::changeMixerForAlarm( int mixer, const char* file, Sound *snd ) {
772#ifndef QT_NO_SOUND 828#ifndef QT_NO_SOUND
773 if (( d->m_sound = ::open ( file, O_RDWR )) >= 0 ) { 829 if (( d->m_sound = ::open ( file, O_RDWR )) >= 0 ) {