From: Xiangyin Ma Date: Thu, 20 Nov 2014 13:15:37 +0000 (+0000) Subject: [dali_1.0.18] Merger branch 'tizen' X-Git-Tag: dali_1.0.22~3^2~4 X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=commitdiff_plain;h=refs%2Fchanges%2F77%2F30577%2F1;hp=1846ed9e60412dbb8aab06aa6bd7c0027d242ac0 [dali_1.0.18] Merger branch 'tizen' Change-Id: I14aba7dfd281128a036519aeb5293ea02b06704a --- diff --git a/automated-tests/src/dali-toolkit-unmanaged/CMakeLists.txt b/automated-tests/src/dali-toolkit-unmanaged/CMakeLists.txt index 457b71b..a41b335 100644 --- a/automated-tests/src/dali-toolkit-unmanaged/CMakeLists.txt +++ b/automated-tests/src/dali-toolkit-unmanaged/CMakeLists.txt @@ -28,7 +28,6 @@ SET(TC_SOURCES utc-Dali-PageTurnEffect.cpp utc-Dali-PageTurnView.cpp utc-Dali-RollLayout.cpp - utc-Dali-RotatingSelector.cpp utc-Dali-ScrollView.cpp utc-Dali-ShadowView.cpp utc-Dali-ShearEffect.cpp diff --git a/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-CheckBoxButton.cpp b/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-CheckBoxButton.cpp index dacff0c..f424000 100644 --- a/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-CheckBoxButton.cpp +++ b/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-CheckBoxButton.cpp @@ -27,9 +27,9 @@ namespace { static bool gCheckBoxButtonState = false; -bool CheckBoxButtonClicked( Button button ) +bool CheckBoxButtonClicked( Button button, bool state ) { - gCheckBoxButtonState = static_cast( button ).IsChecked(); + gCheckBoxButtonState = state; return true; } @@ -75,7 +75,7 @@ int UtcDaliCheckBoxButtonSetGetChecked(void) tet_infoline(" UtcDaliCheckBoxButtonSetGetChecked"); CheckBoxButton checkBoxButton = CheckBoxButton::New(); - checkBoxButton.ClickedSignal().Connect( &CheckBoxButtonClicked ); + checkBoxButton.ToggledSignal().Connect( &CheckBoxButtonClicked ); // global var used to check if CheckBoxButtonClicked is called; gCheckBoxButtonState = false; diff --git a/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-CubeTransitionEffect.cpp b/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-CubeTransitionEffect.cpp index e584bb4..671e19d 100644 --- a/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-CubeTransitionEffect.cpp +++ b/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-CubeTransitionEffect.cpp @@ -36,7 +36,7 @@ const Vector2 PAN_DISPLACEMENT1( -5.f, 5.f ); const Vector2 PAN_POSITION2( VIEW_AREA_SIZE.x * 0.25f, VIEW_AREA_SIZE.y * 0.75f ); const Vector2 PAN_DISPLACEMENT2( 5.f, 5.f ); const int RENDER_FRAME_INTERVAL = 16; -static const float ROTATION_EPSILON = 0.0001f; +static const float FLT_EPISILON = 0.0001f; const float OFFSCREEN_RENDER_DURATION = 0.05f; static bool gObjectCreatedCallBackCalled; @@ -388,30 +388,30 @@ int UtcDaliCubeTransitionWaveEffectStartTransition(void) waveEffect.SetTargetImage( imageActor ); waveEffect.StartTransition(true); Wait( application, TRANSITION_DURATION ); - DALI_TEST_EQUALS( cube.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube.GetChildAt(0).GetCurrentColor() == halfBrightness ); - DALI_TEST_CHECK( cube.GetChildAt(1).GetCurrentColor() == fullBrightness ); + DALI_TEST_EQUALS( cube.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube.GetChildAt(0).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube.GetChildAt(1).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); waveEffect.SetTargetImage( imageActor ); waveEffect.StartTransition(PAN_POSITION1, PAN_DISPLACEMENT1); Wait( application, TRANSITION_DURATION ); - DALI_TEST_EQUALS( cube.GetCurrentRotation(), Quaternion( -2.f*Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube.GetChildAt(0).GetCurrentColor() == fullBrightness ); - DALI_TEST_CHECK( cube.GetChildAt(1).GetCurrentColor() == halfBrightness ); + DALI_TEST_EQUALS( cube.GetCurrentRotation(), Quaternion( -2.f*Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube.GetChildAt(0).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube.GetChildAt(1).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); waveEffect.SetTargetImage( imageActor ); waveEffect.StartTransition(false); Wait( application, TRANSITION_DURATION ); - DALI_TEST_EQUALS( cube.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube.GetChildAt(0).GetCurrentColor() == halfBrightness ); - DALI_TEST_CHECK( cube.GetChildAt(1).GetCurrentColor() == fullBrightness ); + DALI_TEST_EQUALS( cube.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube.GetChildAt(0).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube.GetChildAt(1).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); waveEffect.SetTargetImage( imageActor ); waveEffect.StartTransition(PAN_POSITION2, PAN_DISPLACEMENT2); Wait( application, TRANSITION_DURATION ); - DALI_TEST_EQUALS( cube.GetCurrentRotation(), Quaternion( 0.f, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube.GetChildAt(0).GetCurrentColor() == fullBrightness ); - DALI_TEST_CHECK( cube.GetChildAt(1).GetCurrentColor() == halfBrightness ); + DALI_TEST_EQUALS( cube.GetCurrentRotation(), Quaternion( 0.f, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube.GetChildAt(0).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube.GetChildAt(1).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); END_TEST; } @@ -439,35 +439,36 @@ int UtcDaliCubeTransitionCrossEffectStartTransition(void) crossEffect.SetTargetImage( imageActor ); crossEffect.StartTransition(true); Wait( application, TRANSITION_DURATION ); - DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( Math::PI_2, Vector3::XAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube0.GetChildAt(0).GetCurrentColor() == halfBrightness ); - DALI_TEST_CHECK( cube0.GetChildAt(1).GetCurrentColor() == fullBrightness ); + DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( Math::PI_2, Vector3::XAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(0).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(1).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); + crossEffect.SetTargetImage( imageActor ); crossEffect.StartTransition(PAN_POSITION1, PAN_DISPLACEMENT1); Wait( application, TRANSITION_DURATION ); - DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -2.f*Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( 2.f*Math::PI_2, Vector3::XAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube0.GetChildAt(0).GetCurrentColor() == fullBrightness ); - DALI_TEST_CHECK( cube0.GetChildAt(1).GetCurrentColor() == halfBrightness ); + DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -2.f*Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( 2.f*Math::PI_2, Vector3::XAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(0).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(1).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); crossEffect.SetTargetImage( imageActor ); crossEffect.StartTransition(false); Wait( application, TRANSITION_DURATION ); - DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( Math::PI_2, Vector3::XAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube0.GetChildAt(0).GetCurrentColor() == halfBrightness ); - DALI_TEST_CHECK( cube0.GetChildAt(1).GetCurrentColor() == fullBrightness ); + DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( Math::PI_2, Vector3::XAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(0).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(1).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); crossEffect.SetTargetImage( imageActor ); crossEffect.StartTransition(PAN_POSITION2, PAN_DISPLACEMENT2); Wait( application, TRANSITION_DURATION ); - DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( 0.f, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( 0.f, Vector3::XAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube0.GetChildAt(0).GetCurrentColor() == fullBrightness ); - DALI_TEST_CHECK( cube0.GetChildAt(1).GetCurrentColor() == halfBrightness ); + DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( 0.f, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( 0.f, Vector3::XAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(0).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(1).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); END_TEST; } @@ -494,35 +495,35 @@ int UtcDaliCubeTransitionFoldEffectStartTransition(void) foldEffect.SetTargetImage( imageActor ); foldEffect.StartTransition(true); Wait( application, TRANSITION_DURATION ); - DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube0.GetChildAt(0).GetCurrentColor() == halfBrightness ); - DALI_TEST_CHECK( cube0.GetChildAt(1).GetCurrentColor() == fullBrightness ); + DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(0).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(1).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); foldEffect.SetTargetImage( imageActor ); foldEffect.StartTransition(PAN_POSITION1, PAN_DISPLACEMENT1); Wait( application, TRANSITION_DURATION ); - DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -2.f*Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( 2.f*Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube0.GetChildAt(0).GetCurrentColor() == fullBrightness ); - DALI_TEST_CHECK( cube0.GetChildAt(1).GetCurrentColor() == halfBrightness ); + DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -2.f*Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( 2.f*Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(0).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(1).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); foldEffect.SetTargetImage( imageActor ); foldEffect.StartTransition(false); Wait( application, TRANSITION_DURATION ); - DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube0.GetChildAt(0).GetCurrentColor() == halfBrightness ); - DALI_TEST_CHECK( cube0.GetChildAt(1).GetCurrentColor() == fullBrightness ); + DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(0).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(1).GetCurrentColor(),fullBrightness, FLT_EPISILON, TEST_LOCATION ); foldEffect.SetTargetImage( imageActor ); foldEffect.StartTransition(PAN_POSITION2, PAN_DISPLACEMENT2); Wait( application, TRANSITION_DURATION ); - DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( 0.f, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( 0.f, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube0.GetChildAt(0).GetCurrentColor() == fullBrightness ); - DALI_TEST_CHECK( cube0.GetChildAt(1).GetCurrentColor() == halfBrightness ); + DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( 0.f, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( 0.f, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(0).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(1).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); END_TEST; } @@ -750,9 +751,9 @@ int UtcDaliCubeTransitionWaveEffectStopTransition(void) waveEffect.StopTransition(); application.SendNotification(); application.Render(RENDER_FRAME_INTERVAL); - DALI_TEST_EQUALS( cube.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube.GetChildAt(0).GetCurrentColor() == halfBrightness ); - DALI_TEST_CHECK( cube.GetChildAt(1).GetCurrentColor() == fullBrightness ); + DALI_TEST_EQUALS( cube.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube.GetChildAt(0).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube.GetChildAt(1).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); waveEffect.SetTargetImage( firstImageActor ); waveEffect.StartTransition(PAN_POSITION1, PAN_DISPLACEMENT1); @@ -760,9 +761,9 @@ int UtcDaliCubeTransitionWaveEffectStopTransition(void) waveEffect.StopTransition(); application.SendNotification(); application.Render(RENDER_FRAME_INTERVAL); - DALI_TEST_EQUALS( cube.GetCurrentRotation(), Quaternion( -2.f*Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube.GetChildAt(0).GetCurrentColor() == fullBrightness ); - DALI_TEST_CHECK( cube.GetChildAt(1).GetCurrentColor() == halfBrightness ); + DALI_TEST_EQUALS( cube.GetCurrentRotation(), Quaternion( -2.f*Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube.GetChildAt(0).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube.GetChildAt(1).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); waveEffect.SetTargetImage( secondImageActor ); waveEffect.StartTransition(false); @@ -770,9 +771,9 @@ int UtcDaliCubeTransitionWaveEffectStopTransition(void) waveEffect.StopTransition(); application.SendNotification(); application.Render(RENDER_FRAME_INTERVAL); - DALI_TEST_EQUALS( cube.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube.GetChildAt(0).GetCurrentColor() == halfBrightness ); - DALI_TEST_CHECK( cube.GetChildAt(1).GetCurrentColor() == fullBrightness ); + DALI_TEST_EQUALS( cube.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube.GetChildAt(0).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube.GetChildAt(1).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); waveEffect.SetTargetImage( firstImageActor ); waveEffect.StartTransition(PAN_POSITION2, PAN_DISPLACEMENT2); @@ -780,9 +781,9 @@ int UtcDaliCubeTransitionWaveEffectStopTransition(void) waveEffect.StopTransition(); application.SendNotification(); application.Render(RENDER_FRAME_INTERVAL); - DALI_TEST_EQUALS( cube.GetCurrentRotation(), Quaternion( 0.f, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube.GetChildAt(0).GetCurrentColor() == fullBrightness ); - DALI_TEST_CHECK( cube.GetChildAt(1).GetCurrentColor() == halfBrightness ); + DALI_TEST_EQUALS( cube.GetCurrentRotation(), Quaternion( 0.f, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube.GetChildAt(0).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube.GetChildAt(1).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); END_TEST; } @@ -814,11 +815,11 @@ int UtcDaliCubeTransitionCrossEffectStopTransition(void) crossEffect.StopTransition(); application.SendNotification(); application.Render(RENDER_FRAME_INTERVAL); - DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( Math::PI_2, Vector3::XAXIS), ROTATION_EPSILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( Math::PI_2, Vector3::XAXIS), FLT_EPISILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube0.GetChildAt(0).GetCurrentColor() == halfBrightness ); - DALI_TEST_CHECK( cube0.GetChildAt(1).GetCurrentColor() == fullBrightness ); + DALI_TEST_EQUALS( cube0.GetChildAt(0).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(1).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); crossEffect.SetTargetImage( firstImageActor ); crossEffect.StartTransition(PAN_POSITION1, PAN_DISPLACEMENT1); @@ -826,10 +827,10 @@ int UtcDaliCubeTransitionCrossEffectStopTransition(void) crossEffect.StopTransition(); application.SendNotification(); application.Render(RENDER_FRAME_INTERVAL); - DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -2.f*Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( 2.f*Math::PI_2, Vector3::XAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube0.GetChildAt(0).GetCurrentColor() == fullBrightness ); - DALI_TEST_CHECK( cube0.GetChildAt(1).GetCurrentColor() == halfBrightness ); + DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -2.f*Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( 2.f*Math::PI_2, Vector3::XAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(0).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(1).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); crossEffect.SetTargetImage( secondImageActor ); crossEffect.StartTransition(false); @@ -837,10 +838,10 @@ int UtcDaliCubeTransitionCrossEffectStopTransition(void) crossEffect.StopTransition(); application.SendNotification(); application.Render(RENDER_FRAME_INTERVAL); - DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( Math::PI_2, Vector3::XAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube0.GetChildAt(0).GetCurrentColor() == halfBrightness ); - DALI_TEST_CHECK( cube0.GetChildAt(1).GetCurrentColor() == fullBrightness ); + DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( Math::PI_2, Vector3::XAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(0).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(1).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); crossEffect.SetTargetImage( firstImageActor ); crossEffect.StartTransition(PAN_POSITION2, PAN_DISPLACEMENT2); @@ -848,10 +849,10 @@ int UtcDaliCubeTransitionCrossEffectStopTransition(void) crossEffect.StopTransition(); application.SendNotification(); application.Render(RENDER_FRAME_INTERVAL); - DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( 0.f, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( 0.f, Vector3::XAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube0.GetChildAt(0).GetCurrentColor() == fullBrightness ); - DALI_TEST_CHECK( cube0.GetChildAt(1).GetCurrentColor() == halfBrightness ); + DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( 0.f, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( 0.f, Vector3::XAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(0).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(1).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); END_TEST; } @@ -882,10 +883,10 @@ int UtcDaliCubeTransitionFoldEffectStopTransition(void) foldEffect.StopTransition(); application.SendNotification(); application.Render(RENDER_FRAME_INTERVAL); - DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube0.GetChildAt(0).GetCurrentColor() == halfBrightness ); - DALI_TEST_CHECK( cube0.GetChildAt(1).GetCurrentColor() == fullBrightness ); + DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(0).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(1).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); foldEffect.SetTargetImage( firstImageActor ); foldEffect.StartTransition(PAN_POSITION1, PAN_DISPLACEMENT1); @@ -893,10 +894,10 @@ int UtcDaliCubeTransitionFoldEffectStopTransition(void) foldEffect.StopTransition(); application.SendNotification(); application.Render(RENDER_FRAME_INTERVAL); - DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -2.f*Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( 2.f*Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube0.GetChildAt(0).GetCurrentColor() == fullBrightness ); - DALI_TEST_CHECK( cube0.GetChildAt(1).GetCurrentColor() == halfBrightness ); + DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -2.f*Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( 2.f*Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(0).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(1).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); foldEffect.SetTargetImage( secondImageActor ); foldEffect.StartTransition(false); @@ -904,10 +905,10 @@ int UtcDaliCubeTransitionFoldEffectStopTransition(void) foldEffect.StopTransition(); application.SendNotification(); application.Render(RENDER_FRAME_INTERVAL); - DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( Math::PI_2, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube0.GetChildAt(0).GetCurrentColor() == halfBrightness ); - DALI_TEST_CHECK( cube0.GetChildAt(1).GetCurrentColor() == fullBrightness ); + DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( -Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( Math::PI_2, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(0).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(1).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); foldEffect.SetTargetImage( firstImageActor ); foldEffect.StartTransition(PAN_POSITION2, PAN_DISPLACEMENT2); @@ -915,9 +916,9 @@ int UtcDaliCubeTransitionFoldEffectStopTransition(void) foldEffect.StopTransition(); application.SendNotification(); application.Render(RENDER_FRAME_INTERVAL); - DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( 0.f, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( 0.f, Vector3::YAXIS), ROTATION_EPSILON, TEST_LOCATION ); - DALI_TEST_CHECK( cube0.GetChildAt(0).GetCurrentColor() == fullBrightness ); - DALI_TEST_CHECK( cube0.GetChildAt(1).GetCurrentColor() == halfBrightness ); + DALI_TEST_EQUALS( cube1.GetCurrentRotation(), Quaternion( 0.f, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetCurrentRotation(), Quaternion( 0.f, Vector3::YAXIS), FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(0).GetCurrentColor(), fullBrightness, FLT_EPISILON, TEST_LOCATION ); + DALI_TEST_EQUALS( cube0.GetChildAt(1).GetCurrentColor(), halfBrightness, FLT_EPISILON, TEST_LOCATION ); END_TEST; } diff --git a/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-KeyboardFocusManager.cpp b/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-KeyboardFocusManager.cpp index 882d5e7..86d0451 100644 --- a/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-KeyboardFocusManager.cpp +++ b/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-KeyboardFocusManager.cpp @@ -388,7 +388,7 @@ int UtcDaliKeyboardFocusManagerSignalFocusGroupChanged(void) manager.FocusGroupChangedSignal().Connect( &focusGroupChangedCallback, &FocusGroupChangedCallback::Callback ); Integration::KeyEvent tabEvent("Tab", "", 0, 0, 0, Integration::KeyEvent::Down); - Integration::KeyEvent shiftTabEvent("Tab", "", 1, 0, 0, Integration::KeyEvent::Down); + Integration::KeyEvent shiftTabEvent("Tab", "", 0, 1, 0, Integration::KeyEvent::Down); // Send the tab event to change focus group in the forward direction application.ProcessEvent(tabEvent); diff --git a/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-PageTurnView.cpp b/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-PageTurnView.cpp index d594aa9..4b314c0 100644 --- a/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-PageTurnView.cpp +++ b/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-PageTurnView.cpp @@ -26,18 +26,6 @@ using namespace Dali; using namespace Dali::Toolkit; -void dali_page_turn_view_startup(void) -{ - test_return_value = TET_UNDEF; -} - -void dali_page_turn_view_cleanup(void) -{ - test_return_value = TET_PASS; -} - - - namespace { const int RENDER_FRAME_INTERVAL = 16; ///< Duration of each frame in ms. (at approx 60FPS) @@ -61,20 +49,14 @@ static void TestCallback(BaseHandle handle) * * @param application Test application instance * @param duration Time to pass in milliseconds. - * @return The actual time passed in milliseconds */ -int Wait(ToolkitTestApplication& application, int duration = 0) +void Wait(ToolkitTestApplication& application, int duration = 0) { - int time = 0; - for(int i = 0; i <= ( duration / RENDER_FRAME_INTERVAL); i++) { application.SendNotification(); application.Render(RENDER_FRAME_INTERVAL); - time += RENDER_FRAME_INTERVAL; } - - return time; } // Generate a PanGestureEvent to send to Core @@ -256,6 +238,15 @@ private: }// namespace +void dali_page_turn_view_startup(void) +{ + test_return_value = TET_UNDEF; +} + +void dali_page_turn_view_cleanup(void) +{ + test_return_value = TET_PASS; +} int UtcDaliPageTurnPortraitViewNew(void) { @@ -374,6 +365,8 @@ int UtcDaliPageTurnViewEnterLeaveEditMode(void) tet_infoline( " UtcDaliPageTurnViewEnterLeaveEditMode " ); + application.GetGlAbstraction().SetCheckFramebufferStatusResult(GL_FRAMEBUFFER_COMPLETE ); + TestPageFactory factory(application); factory.EnableOffscreenRendering( ); @@ -423,6 +416,8 @@ int UtcDaliPageTurnViewGetHitActor(void) tet_infoline(" UtcDaliPageTurnViewGetHitActor "); + application.GetGlAbstraction().SetCheckFramebufferStatusResult(GL_FRAMEBUFFER_COMPLETE ); + TestPageFactory factory(application); factory.EnableOffscreenRendering( ); @@ -458,6 +453,8 @@ int UtcDaliPageTurnViewRefresh(void) tet_infoline(" UtcDaliPageTurnViewRefresh "); + application.GetGlAbstraction().SetCheckFramebufferStatusResult(GL_FRAMEBUFFER_COMPLETE ); + TestPageFactory factory(application); factory.EnableOffscreenRendering( ); PageTurnView pageTurnView = PageTurnPortraitView::New( factory, PAGE_SIZE ); @@ -496,6 +493,8 @@ int UtcDaliPageTurnViewSignals(void) tet_infoline(" UtcDaliPageTurnViewSignals "); + application.GetGlAbstraction().SetCheckFramebufferStatusResult(GL_FRAMEBUFFER_COMPLETE ); + TestPageFactory factory(application); Vector2 size = Stage::GetCurrent().GetSize(); PageTurnView portraitView = PageTurnPortraitView::New( factory, size ); diff --git a/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-RotatingSelector.cpp b/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-RotatingSelector.cpp deleted file mode 100644 index 48a3af8..0000000 --- a/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-RotatingSelector.cpp +++ /dev/null @@ -1,257 +0,0 @@ -/* - * Copyright (c) 2014 Samsung Electronics Co., Ltd. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * - */ - -#include -#include -#include -#include -#include - - - -using namespace Dali; -using namespace Toolkit; - - -namespace -{ -static bool gObjectCreatedCallBackCalled; - -static void TestCallback(BaseHandle handle) -{ - gObjectCreatedCallBackCalled = true; -} - -static bool gSelectedSignalReceived = false; -static bool gSelected = false; - -const Dali::TouchPoint pointDownInside( 0, TouchPoint::Down, 240, 400 ); -const Dali::TouchPoint pointUpInside( 0, TouchPoint::Up, 240, 400 ); -} // namespace - - -void rotating_selector_startup(void) -{ - test_return_value = TET_UNDEF; -} - -void rotating_selector_cleanup(void) -{ - test_return_value = TET_PASS; -} - - -int UtcDaliRotatingSelectorNew(void) -{ - ToolkitTestApplication application; - - tet_infoline("UtcDaliRotatingSelectorNew"); - RotatingSelector selector; - - DALI_TEST_CHECK(!selector); - - Actor unSelectedActor = Actor::New(); - Actor selectedActor = Actor::New(); - - selector = RotatingSelector::New(unSelectedActor, selectedActor); - - DALI_TEST_CHECK(selector); - - //Additional check to ensure object is created by checking if it's registered - ObjectRegistry registry = Stage::GetCurrent().GetObjectRegistry(); - DALI_TEST_CHECK( registry ); - - gObjectCreatedCallBackCalled = false; - registry.ObjectCreatedSignal().Connect(&TestCallback); - { - RotatingSelector selector = RotatingSelector::New(unSelectedActor, selectedActor); - } - DALI_TEST_CHECK( gObjectCreatedCallBackCalled ); - END_TEST; -} - -namespace -{ - -// Callback test function -void OnSelectedSignal(RotatingSelector actor, bool selected) -{ - gSelectedSignalReceived = true; - gSelected = selected; -} - -} - - -int UtcDaliRotatingSelectorSetSelected(void) -{ - ToolkitTestApplication application; - - tet_infoline("UtcDaliRotatingSelectorSetSelected"); - - BitmapImage img = BitmapImage::New( 1,1 ); - ImageActor unSelectedActor = ImageActor::New( img ); - ImageActor selectedActor = ImageActor::New( img ); - - RotatingSelector selector = RotatingSelector::New(unSelectedActor, selectedActor); - - selector.SetAnchorPoint( AnchorPoint::TOP_LEFT ); - selector.SetParentOrigin( ParentOrigin::TOP_LEFT ); - selector.SetPosition( 240, 400 ); - selector.SetSize( 100, 100 ); - - // connect to its selected signal - selector.SelectedSignal().Connect( &OnSelectedSignal ); - - Stage::GetCurrent().Add( selector ); - - gSelectedSignalReceived = false; - gSelected = false; - - selector.SetSelected(true); - application.SendNotification(); - application.Render(1000); - application.SendNotification(); - application.Render(1000); - application.SendNotification(); - application.Render(1000); - - DALI_TEST_CHECK( selector.IsSelected() ); - DALI_TEST_CHECK( gSelectedSignalReceived ); - DALI_TEST_CHECK( gSelected ); - - gSelectedSignalReceived = false; - gSelected = false; - - selector.SetSelected(false); - application.SendNotification(); - application.Render(1000); - application.SendNotification(); - application.Render(1000); - application.SendNotification(); - application.Render(1000); - - DALI_TEST_CHECK( gSelectedSignalReceived ); - DALI_TEST_CHECK( !gSelected ); - DALI_TEST_CHECK( !selector.IsSelected() ); - END_TEST; -} - -int UtcDaliRotatingSelectorSetSelectedAndUnSelectedActor(void) -{ - ToolkitTestApplication application; - - tet_infoline("UtcDaliRotatingSelectorSetSelectedAndUnSelectedActor"); - - BitmapImage img = BitmapImage::New( 1,1 ); - ImageActor actor1 = ImageActor::New( img ); - ImageActor actor2 = ImageActor::New( img ); - - RotatingSelector selector = RotatingSelector::New(actor1, actor2); - Stage::GetCurrent().Add( selector ); - - ImageActor unSelectedActor = ImageActor::New( img ); - ImageActor selectedActor = ImageActor::New( img ); - - selector.SetSelectedActor(selectedActor); - - Actor actor3 = selector.GetSelectedActor(); - DALI_TEST_CHECK( selectedActor == actor3 ); - - selector.SetUnSelectedActor(unSelectedActor); - - Actor actor4 = selector.GetUnSelectedActor(); - DALI_TEST_CHECK( unSelectedActor == actor4 ); - - END_TEST; -} - - -int UtcDaliRotatingSelectorSetSelectable(void) -{ - ToolkitTestApplication application; - - tet_infoline("UtcDaliRotatingSelectorSetSelectable"); - - BitmapImage img = BitmapImage::New( 1,1 ); - ImageActor unSelectedActor = ImageActor::New( img ); - ImageActor selectedActor = ImageActor::New( img ); - - RotatingSelector selector = RotatingSelector::New(unSelectedActor, selectedActor); - - selector.SetSelectable(true); - DALI_TEST_CHECK( selector.IsSelectable() ); - - selector.SetSelectable(false); - DALI_TEST_CHECK( !selector.IsSelectable() ); - END_TEST; -} - -int UtcDaliRotatingSelectorSignalSelected(void) -{ - ToolkitTestApplication application; - - tet_infoline("UtcDaliRotatingSelectorSignalSelected"); - - BitmapImage img = BitmapImage::New( 1,1 ); - ImageActor unSelectedActor = ImageActor::New( img ); - ImageActor selectedActor = ImageActor::New( img ); - - RotatingSelector selector = RotatingSelector::New(unSelectedActor, selectedActor); - - selector.SetAnchorPoint( AnchorPoint::TOP_LEFT ); - selector.SetParentOrigin( ParentOrigin::TOP_LEFT ); - selector.SetPosition( 240, 400 ); - selector.SetSize( 100, 100 ); - - // connect to its selected signal - selector.SelectedSignal().Connect( &OnSelectedSignal ); - - Stage::GetCurrent().Add( selector ); - - DALI_TEST_CHECK( !selector.IsSelected() ); - - gSelectedSignalReceived = false; - gSelected = false; - - application.SendNotification(); - application.Render(1000); - application.SendNotification(); - application.Render(1000); - - //Test using touch event simulation - Dali::Integration::TouchEvent event; - - event = Dali::Integration::TouchEvent(); - event.AddPoint( pointDownInside ); - application.ProcessEvent( event ); - - event = Dali::Integration::TouchEvent(); - event.AddPoint( pointUpInside ); - application.ProcessEvent( event ); - - application.SendNotification(); - application.Render(1000); - application.SendNotification(); - application.Render(1000); - - DALI_TEST_CHECK( selector.IsSelected() ); - DALI_TEST_CHECK( gSelectedSignalReceived ); - DALI_TEST_CHECK( gSelected ); - - END_TEST; -} diff --git a/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-ScrollView.cpp b/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-ScrollView.cpp index 267e811..867abd8 100644 --- a/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-ScrollView.cpp +++ b/automated-tests/src/dali-toolkit-unmanaged/utc-Dali-ScrollView.cpp @@ -1039,27 +1039,16 @@ int UtcDaliRulerFixedRulerSpacing(void) ToolkitTestApplication application; tet_infoline(" UtcDaliRulerFixedRulerSpacing"); - RulerPtr rulerZero = new FixedRuler( 0.0f ); - rulerZero->SetDomain( RulerDomain(10.0f, 90.0f, true) ); - RulerPtr rulerNormal = new FixedRuler( 25.0f ); rulerNormal->SetDomain( RulerDomain(10.0f, 90.0f, true) ); unsigned int volume; float position; - position = rulerZero->GetPositionFromPage(1, volume, true); - DALI_TEST_EQUALS( position, 10.0f, TEST_LOCATION ); - DALI_TEST_EQUALS( volume, 1u, TEST_LOCATION ); - position = rulerNormal->GetPositionFromPage(1, volume, true); DALI_TEST_EQUALS( position, 35.0f, TEST_LOCATION ); DALI_TEST_EQUALS( volume, 0u, TEST_LOCATION ); - position = rulerZero->GetPositionFromPage(2, volume, true); - DALI_TEST_EQUALS( position, 10.0f, TEST_LOCATION ); - DALI_TEST_EQUALS( volume, 2u, TEST_LOCATION ); - position = rulerNormal->GetPositionFromPage(2, volume, true); DALI_TEST_EQUALS( position, 60.0f, TEST_LOCATION ); DALI_TEST_EQUALS( volume, 0u, TEST_LOCATION ); diff --git a/base/dali-toolkit/internal/controls/text-input/text-input-decorator-impl.cpp b/base/dali-toolkit/internal/controls/text-input/text-input-decorator-impl.cpp index 6ac183f..9f83898 100644 --- a/base/dali-toolkit/internal/controls/text-input/text-input-decorator-impl.cpp +++ b/base/dali-toolkit/internal/controls/text-input/text-input-decorator-impl.cpp @@ -93,6 +93,7 @@ Decorator::Decorator( TextViewCharacterPositioning& textViewManager, TextInputTe mCursorRTLEnabled( false ), mIsGrabHandleInScrollArea( false ), mIsCursorInScrollArea( false ), + mGrabHandleVisibility( false ), mGrabHandleEnabled( true ) { } diff --git a/base/dali-toolkit/internal/controls/text-input/text-input-text-highlight-impl.cpp b/base/dali-toolkit/internal/controls/text-input/text-input-text-highlight-impl.cpp index 469c0aa..7475678 100644 --- a/base/dali-toolkit/internal/controls/text-input/text-input-text-highlight-impl.cpp +++ b/base/dali-toolkit/internal/controls/text-input/text-input-text-highlight-impl.cpp @@ -208,12 +208,15 @@ TextHighlight::HighlightInfo TextHighlight::CalculateHighlightInfo( std::size_t { lastIt = std::max( textLayoutInfo.mCharacterLayoutInfoTable.begin(), lastIt - 1 ); } - const Size rowSize( mTextViewCharacterPositioning.GetRowRectFromCharacterPosition( lastIt - textLayoutInfo.mCharacterLayoutInfoTable.begin(), min, max ) ); - maxRowLeft = std::min(maxRowLeft, min.x); - maxRowRight = std::max(maxRowRight, max.x); - float rowBottom = lastIt->mPosition.y - textLayoutInfo.mScrollOffset.y; - float rowTop = rowBottom - rowSize.height; - newHighlightInfo.AddQuad( rowLeft, rowTop, rowRight, rowBottom ); + if( lastIt != end ) + { + const Size rowSize( mTextViewCharacterPositioning.GetRowRectFromCharacterPosition( lastIt - textLayoutInfo.mCharacterLayoutInfoTable.begin(), min, max ) ); + maxRowLeft = std::min(maxRowLeft, min.x); + maxRowRight = std::max(maxRowRight, max.x); + float rowBottom = lastIt->mPosition.y - textLayoutInfo.mScrollOffset.y; + float rowTop = rowBottom - rowSize.height; + newHighlightInfo.AddQuad( rowLeft, rowTop, rowRight, rowBottom ); + } } } diff --git a/base/dali-toolkit/internal/focus-manager/focus-manager-impl.cpp b/base/dali-toolkit/internal/focus-manager/focus-manager-impl.cpp index b72eb82..efe85b7 100644 --- a/base/dali-toolkit/internal/focus-manager/focus-manager-impl.cpp +++ b/base/dali-toolkit/internal/focus-manager/focus-manager-impl.cpp @@ -459,7 +459,7 @@ void FocusManager::DoActivate(Actor actor) if(control) { // Notify the control that it is activated - control.GetImplementation().OnActivated(); + control.GetImplementation().Activate(); } // Send notification for the activation of focused actor diff --git a/base/dali-toolkit/internal/focus-manager/keyboard-focus-manager-impl.cpp b/base/dali-toolkit/internal/focus-manager/keyboard-focus-manager-impl.cpp index f766b0b..0ccc095 100644 --- a/base/dali-toolkit/internal/focus-manager/keyboard-focus-manager-impl.cpp +++ b/base/dali-toolkit/internal/focus-manager/keyboard-focus-manager-impl.cpp @@ -340,7 +340,7 @@ void KeyboardFocusManager::DoActivate(Actor actor) if(control) { // Notify the control that it is activated - control.GetImplementation().OnActivated(); + control.GetImplementation().Activate(); } // Send notification for the activation of focused actor @@ -559,8 +559,6 @@ void KeyboardFocusManager::OnKeyEvent(const KeyEvent& event) // Move the focus towards right MoveFocus(Toolkit::Control::Right); } - - isFocusStartableKey = true; } else { diff --git a/base/dali-toolkit/public-api/controls/control-impl.cpp b/base/dali-toolkit/public-api/controls/control-impl.cpp index 2666cd7..bea8263 100644 --- a/base/dali-toolkit/public-api/controls/control-impl.cpp +++ b/base/dali-toolkit/public-api/controls/control-impl.cpp @@ -606,84 +606,136 @@ Control::~Control() delete mImpl; } -void Control::Initialize() +void Control::SetSizePolicy( Toolkit::Control::SizePolicy widthPolicy, Toolkit::Control::SizePolicy heightPolicy ) { + bool relayoutRequest( false ); - // Calling deriving classes - OnInitialize(); - - if( mImpl->mFlags & REQUIRES_STYLE_CHANGE_SIGNALS ) + if ( ( mImpl->mWidthPolicy != widthPolicy ) || ( mImpl->mHeightPolicy != heightPolicy ) ) { - Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get(); + relayoutRequest = true; + } - // Register for style changes - styleManager.StyleChangeSignal().Connect( this, &Control::DoStyleChange ); + mImpl->mWidthPolicy = widthPolicy; + mImpl->mHeightPolicy = heightPolicy; - // SetTheme - GetImpl( styleManager ).ApplyThemeStyle( GetOwner() ); + // Ensure RelayoutRequest is called AFTER new policies have been set. + if ( relayoutRequest ) + { + RelayoutRequest(); } +} - SetRequiresHoverEvents(mImpl->mFlags & REQUIRES_HOVER_EVENTS); - SetRequiresMouseWheelEvents(mImpl->mFlags & REQUIRES_MOUSE_WHEEL_EVENTS); - - mImpl->mInitialized = true; +void Control::GetSizePolicy( Toolkit::Control::SizePolicy& widthPolicy, Toolkit::Control::SizePolicy& heightPolicy ) const +{ + widthPolicy = mImpl->mWidthPolicy; + heightPolicy = mImpl->mHeightPolicy; } -void Control::EnableGestureDetection(Gesture::Type type) +void Control::SetMinimumSize( const Vector3& size ) { - if ( (type & Gesture::Pinch) && !mImpl->mPinchGestureDetector ) + const Vector3& minSize = mImpl->GetMinimumSize(); + if ( fabsf( minSize.width - size.width ) > Math::MACHINE_EPSILON_1000 || + fabsf( minSize.height - size.height ) > Math::MACHINE_EPSILON_1000 ) { - mImpl->mPinchGestureDetector = PinchGestureDetector::New(); - mImpl->mPinchGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PinchDetected); - mImpl->mPinchGestureDetector.Attach(Self()); - } + mImpl->SetMinimumSize( size ); - if ( (type & Gesture::Pan) && !mImpl->mPanGestureDetector ) - { - mImpl->mPanGestureDetector = PanGestureDetector::New(); - mImpl->mPanGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PanDetected); - mImpl->mPanGestureDetector.Attach(Self()); + // Only relayout if our control is using the minimum or range policy. + if ( ( mImpl->mHeightPolicy == Toolkit::Control::Minimum ) || ( mImpl->mWidthPolicy == Toolkit::Control::Minimum ) || + ( mImpl->mHeightPolicy == Toolkit::Control::Range ) || ( mImpl->mWidthPolicy == Toolkit::Control::Range ) ) + { + RelayoutRequest(); + } } +} - if ( (type & Gesture::Tap) && !mImpl->mTapGestureDetector ) +const Vector3& Control::GetMinimumSize() const +{ + return mImpl->GetMinimumSize(); +} + +void Control::SetMaximumSize( const Vector3& size ) +{ + const Vector3& maxSize = mImpl->GetMaximumSize(); + if ( fabsf( maxSize.width - size.width ) > Math::MACHINE_EPSILON_1000 || + fabsf( maxSize.height - size.height ) > Math::MACHINE_EPSILON_1000 ) { - mImpl->mTapGestureDetector = TapGestureDetector::New(); - mImpl->mTapGestureDetector.DetectedSignal().Connect(mImpl, &Impl::TapDetected); - mImpl->mTapGestureDetector.Attach(Self()); + mImpl->SetMaximumSize( size ); + + // Only relayout if our control is using the maximum or range policy. + if ( ( mImpl->mHeightPolicy == Toolkit::Control::Maximum ) || ( mImpl->mWidthPolicy == Toolkit::Control::Maximum ) || + ( mImpl->mHeightPolicy == Toolkit::Control::Range ) || ( mImpl->mWidthPolicy == Toolkit::Control::Range ) ) + { + RelayoutRequest(); + } } +} - if ( (type & Gesture::LongPress) && !mImpl->mLongPressGestureDetector ) +const Vector3& Control::GetMaximumSize() const +{ + return mImpl->GetMaximumSize(); +} + +Vector3 Control::GetNaturalSize() +{ + // could be overridden in derived classes. + return mImpl->mNaturalSize; +} + +float Control::GetHeightForWidth( float width ) +{ + // could be overridden in derived classes. + float height( 0.0f ); + if ( mImpl->mNaturalSize.width > 0.0f ) { - mImpl->mLongPressGestureDetector = LongPressGestureDetector::New(); - mImpl->mLongPressGestureDetector.DetectedSignal().Connect(mImpl, &Impl::LongPressDetected); - mImpl->mLongPressGestureDetector.Attach(Self()); + height = mImpl->mNaturalSize.height * width / mImpl->mNaturalSize.width; } + return height; } -void Control::DisableGestureDetection(Gesture::Type type) +float Control::GetWidthForHeight( float height ) { - if ( (type & Gesture::Pinch) && mImpl->mPinchGestureDetector ) + // could be overridden in derived classes. + float width( 0.0f ); + if ( mImpl->mNaturalSize.height > 0.0f ) { - mImpl->mPinchGestureDetector.Detach(Self()); - mImpl->mPinchGestureDetector.Reset(); + width = mImpl->mNaturalSize.width * height / mImpl->mNaturalSize.height; } + return width; +} - if ( (type & Gesture::Pan) && mImpl->mPanGestureDetector ) +const Vector3& Control::GetControlSize() const +{ + return mImpl->mCurrentSize; +} + +const Vector3& Control::GetSizeSet() const +{ + return mImpl->mNaturalSize; +} + +void Control::SetKeyInputFocus() +{ + if( Self().OnStage() ) { - mImpl->mPanGestureDetector.Detach(Self()); - mImpl->mPanGestureDetector.Reset(); + Toolkit::KeyInputFocusManager::Get().SetFocus(Toolkit::Control::DownCast(Self())); } +} - if ( (type & Gesture::Tap) && mImpl->mTapGestureDetector ) +bool Control::HasKeyInputFocus() +{ + bool result = false; + if( Self().OnStage() ) { - mImpl->mTapGestureDetector.Detach(Self()); - mImpl->mTapGestureDetector.Reset(); + result = Toolkit::KeyInputFocusManager::Get().IsKeyboardListener(Toolkit::Control::DownCast(Self())); } + return result; +} - if ( (type & Gesture::LongPress) && mImpl->mLongPressGestureDetector) +void Control::ClearKeyInputFocus() +{ + if( Self().OnStage() ) { - mImpl->mLongPressGestureDetector.Detach(Self()); - mImpl->mLongPressGestureDetector.Reset(); + Toolkit::KeyInputFocusManager::Get().RemoveFocus(Toolkit::Control::DownCast(Self())); } } @@ -782,165 +834,140 @@ Actor Control::GetBackgroundActor() const return Actor(); } -void Control::OnThemeChange( Toolkit::StyleManager styleManager ) +void Control::SetKeyboardNavigationSupport(bool isSupported) { - GetImpl( styleManager ).ApplyThemeStyle( GetOwner() ); + mImpl->mIsKeyboardNavigationSupported = isSupported; } -void Control::OnPinch(const PinchGesture& pinch) +bool Control::IsKeyboardNavigationSupported() { - if( !( mImpl->mStartingPinchScale ) ) - { - // lazy allocate - mImpl->mStartingPinchScale = new Vector3; - } - - if( pinch.state == Gesture::Started ) - { - *( mImpl->mStartingPinchScale ) = Self().GetCurrentScale(); - } - - Self().SetScale( *( mImpl->mStartingPinchScale ) * pinch.scale ); + return mImpl->mIsKeyboardNavigationSupported; } -void Control::OnPan( const PanGesture& pan ) +void Control::Activate() { + // Inform deriving classes + OnActivated(); } -void Control::OnTap(const TapGesture& tap) +bool Control::OnAccessibilityPan(PanGesture gesture) { + return false; // Accessibility pan gesture is not handled by default } -void Control::OnLongPress( const LongPressGesture& longPress ) +bool Control::OnAccessibilityTouch(const TouchEvent& touchEvent) { + return false; // Accessibility touch event is not handled by default } -void Control::OnStageConnection() +bool Control::OnAccessibilityValueChange(bool isIncrease) { - RelayoutRequest(); - - // Notify derived classes. - OnControlStageConnection(); + return false; // Accessibility value change action is not handled by default } -void Control::OnStageDisconnection() +void Control::NegotiateSize( Vector2 allocatedSize, ActorSizeContainer& container ) { - // Notify derived classes - OnControlStageDisconnection(); -} + Vector2 size; -void Control::OnChildAdd(Actor& child) -{ - // If this is the background actor, then we do not want to relayout or inform deriving classes - if ( mImpl->mBackground && ( child == mImpl->mBackground->actor ) ) + if ( mImpl->mWidthPolicy == Toolkit::Control::Fixed ) { - return; - } + if ( mImpl->mHeightPolicy == Toolkit::Control::Fixed ) + { + // If a control says it has a fixed size, then use the size set by the application / control. + Vector2 setSize( mImpl->mNaturalSize ); + if ( setSize != Vector2::ZERO ) + { + size = setSize; - // Request for relayout as we may need to position the new child and old ones - RelayoutRequest(); + // Policy is set to Fixed, so if the application / control has not set one of the dimensions, + // then we should use the natural size of the control rather than the full allocation. + if ( EqualsZero( size.width ) ) + { + size.width = GetWidthForHeight( size.height ); + } + else if ( EqualsZero( size.height ) ) + { + size.height = GetHeightForWidth( size.width ); + } + } + else + { + // If that is not set then set the size to the control's natural size + size = Vector2( GetNaturalSize() ); + } + } + else + { + // Width is fixed so if the application / control has set it, then use that. + if ( !EqualsZero( mImpl->mNaturalSize.width ) ) + { + size.width = mImpl->mNaturalSize.width; + } + else + { + // Otherwise, set the width to what has been allocated. + size.width = allocatedSize.width; + } - // Notify derived classes. - OnControlChildAdd( child ); -} + // Height is flexible so ask control what the height should be for our width. + size.height = GetHeightForWidth( size.width ); -void Control::OnChildRemove(Actor& child) -{ - // If this is the background actor, then we do not want to relayout or inform deriving classes - if ( mImpl->mBackground && ( child == mImpl->mBackground->actor ) ) - { - return; + // Ensure height is within our policy rules + size.height = Calculate( mImpl->mHeightPolicy, GetMinimumSize().height, GetMaximumSize().height, size.height ); + } } - - // Request for relayout as we may need to re-position the old child - RelayoutRequest(); - - // Notify derived classes. - OnControlChildRemove( child ); -} - -void Control::OnSizeSet(const Vector3& targetSize) -{ - if( ( !mImpl->mInsideRelayout ) && ( targetSize != mImpl->mNaturalSize ) ) + else { - // Only updates size if set through Actor's API - mImpl->mNaturalSize = targetSize; - } + if ( mImpl->mHeightPolicy == Toolkit::Control::Fixed ) + { + // Height is fixed so if the application / control has set it, then use that. + if ( !EqualsZero( mImpl->mNaturalSize.height ) ) + { + size.height = mImpl->mNaturalSize.height; + } + else + { + // Otherwise, set the height to what has been allocated. + size.height = allocatedSize.height; + } - if( targetSize != mImpl->mCurrentSize ) - { - // Update control size. - mImpl->mCurrentSize = targetSize; + // Width is flexible so ask control what the width should be for our height. + size.width = GetWidthForHeight( size.height ); - // Notify derived classes. - OnControlSizeSet( targetSize ); + // Ensure width is within our policy rules + size.width = Calculate( mImpl->mWidthPolicy, mImpl->GetMinimumSize().width, mImpl->GetMaximumSize().width, size.width ); + } + else + { + // Width and height are BOTH flexible. + // Calculate the width and height using the policy rules. + size.width = Calculate( mImpl->mWidthPolicy, mImpl->GetMinimumSize().width, mImpl->GetMaximumSize().width, allocatedSize.width ); + size.height = Calculate( mImpl->mHeightPolicy, mImpl->GetMinimumSize().height, mImpl->GetMaximumSize().height, allocatedSize.height ); + } } -} - -void Control::OnSizeAnimation(Animation& animation, const Vector3& targetSize) -{ - // @todo consider animating negotiated child sizes to target size -} - -bool Control::OnTouchEvent(const TouchEvent& event) -{ - return false; // Do not consume -} - -bool Control::OnHoverEvent(const HoverEvent& event) -{ - return false; // Do not consume -} - -bool Control::OnKeyEvent(const KeyEvent& event) -{ - return false; // Do not consume -} - -bool Control::OnMouseWheelEvent(const MouseWheelEvent& event) -{ - return false; // Do not consume -} - -void Control::OnKeyInputFocusGained() -{ - // Do Nothing -} - -void Control::OnKeyInputFocusLost() -{ - // Do Nothing -} - -Actor Control::GetChildByAlias(const std::string& actorAlias) -{ - return Actor(); -} - -bool Control::OnAccessibilityPan(PanGesture gesture) -{ - return false; // Accessibility pan gesture is not handled by default -} - -bool Control::OnAccessibilityTouch(const TouchEvent& touchEvent) -{ - return false; // Accessibility touch event is not handled by default -} -bool Control::OnAccessibilityValueChange(bool isIncrease) -{ - return false; // Accessibility value change action is not handled by default -} + // If the width has not been set, then set to the allocated width. + // Also if the width set is greater than the allocated, then set to allocated (no exceed support). + if ( EqualsZero( size.width ) || ( size.width > allocatedSize.width ) ) + { + size.width = allocatedSize.width; + } + // If the height has not been set, then set to the allocated height. + // Also if the height set is greater than the allocated, then set to allocated (no exceed support). + if ( EqualsZero( size.height ) || ( size.height > allocatedSize.height ) ) + { + size.height = allocatedSize.height; + } -void Control::SetKeyboardNavigationSupport(bool isSupported) -{ - mImpl->mIsKeyboardNavigationSupported = isSupported; -} + DALI_LOG_INFO( gLogFilter, Debug::Verbose, + "%p: Natural: [%.2f, %.2f] Allocated: [%.2f, %.2f] Set: [%.2f, %.2f]\n", + Self().GetObjectPtr(), + GetNaturalSize().x, GetNaturalSize().y, + allocatedSize.x, allocatedSize.y, + size.x, size.y ); -bool Control::IsKeyboardNavigationSupported() -{ - return mImpl->mIsKeyboardNavigationSupported; + Relayout( size, container ); } void Control::SetAsKeyboardFocusGroup(bool isFocusGroup) @@ -961,6 +988,10 @@ Actor Control::GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit: return Actor(); } +void Control::OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor) +{ +} + bool Control::DoAction(BaseObject* object, const std::string& actionName, const PropertyValueContainer& attributes) { bool ret = false; @@ -1022,153 +1053,118 @@ bool Control::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* t return connected; } -void Control::DoStyleChange( Toolkit::StyleManager styleManager, StyleChange change ) -{ - if( change.themeChange ) - { - OnThemeChange( styleManager ); - } - else if( change.defaultFontChange || change.defaultFontSizeChange ) - { - OnFontChange( change.defaultFontChange, change.defaultFontSizeChange ); - } -} - Toolkit::Control::KeyEventSignalV2& Control::KeyEventSignal() { return mImpl->mKeyEventSignalV2; } -void Control::SetSizePolicy( Toolkit::Control::SizePolicy widthPolicy, Toolkit::Control::SizePolicy heightPolicy ) +bool Control::EmitKeyEventSignal( const KeyEvent& event ) { - bool relayoutRequest( false ); + // Guard against destruction during signal emission + Dali::Toolkit::Control handle( GetOwner() ); - if ( ( mImpl->mWidthPolicy != widthPolicy ) || ( mImpl->mHeightPolicy != heightPolicy ) ) + bool consumed = false; + + // signals are allocated dynamically when someone connects + if ( !mImpl->mKeyEventSignalV2.Empty() ) { - relayoutRequest = true; + consumed = mImpl->mKeyEventSignalV2.Emit( handle, event ); } - mImpl->mWidthPolicy = widthPolicy; - mImpl->mHeightPolicy = heightPolicy; - - // Ensure RelayoutRequest is called AFTER new policies have been set. - if ( relayoutRequest ) + if (!consumed) { - RelayoutRequest(); + // Notification for derived classes + consumed = OnKeyEvent(event); } + + return consumed; } -void Control::GetSizePolicy( Toolkit::Control::SizePolicy& widthPolicy, Toolkit::Control::SizePolicy& heightPolicy ) const +Control::Control( ControlBehaviour behaviourFlags ) +: CustomActorImpl( behaviourFlags & REQUIRES_TOUCH_EVENTS ), + mImpl(new Impl(*this)) { - widthPolicy = mImpl->mWidthPolicy; - heightPolicy = mImpl->mHeightPolicy; + mImpl->mFlags = behaviourFlags; } -void Control::SetMinimumSize( const Vector3& size ) +void Control::Initialize() { - const Vector3& minSize = mImpl->GetMinimumSize(); - if ( fabsf( minSize.width - size.width ) > Math::MACHINE_EPSILON_1000 || - fabsf( minSize.height - size.height ) > Math::MACHINE_EPSILON_1000 ) + + // Calling deriving classes + OnInitialize(); + + if( mImpl->mFlags & REQUIRES_STYLE_CHANGE_SIGNALS ) { - mImpl->SetMinimumSize( size ); + Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get(); - // Only relayout if our control is using the minimum or range policy. - if ( ( mImpl->mHeightPolicy == Toolkit::Control::Minimum ) || ( mImpl->mWidthPolicy == Toolkit::Control::Minimum ) || - ( mImpl->mHeightPolicy == Toolkit::Control::Range ) || ( mImpl->mWidthPolicy == Toolkit::Control::Range ) ) - { - RelayoutRequest(); - } + // Register for style changes + styleManager.StyleChangeSignal().Connect( this, &Control::DoStyleChange ); + + // SetTheme + GetImpl( styleManager ).ApplyThemeStyle( GetOwner() ); } -} -const Vector3& Control::GetMinimumSize() const -{ - return mImpl->GetMinimumSize(); + SetRequiresHoverEvents(mImpl->mFlags & REQUIRES_HOVER_EVENTS); + SetRequiresMouseWheelEvents(mImpl->mFlags & REQUIRES_MOUSE_WHEEL_EVENTS); + + mImpl->mInitialized = true; } -void Control::SetMaximumSize( const Vector3& size ) +void Control::EnableGestureDetection(Gesture::Type type) { - const Vector3& maxSize = mImpl->GetMaximumSize(); - if ( fabsf( maxSize.width - size.width ) > Math::MACHINE_EPSILON_1000 || - fabsf( maxSize.height - size.height ) > Math::MACHINE_EPSILON_1000 ) + if ( (type & Gesture::Pinch) && !mImpl->mPinchGestureDetector ) { - mImpl->SetMaximumSize( size ); + mImpl->mPinchGestureDetector = PinchGestureDetector::New(); + mImpl->mPinchGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PinchDetected); + mImpl->mPinchGestureDetector.Attach(Self()); + } - // Only relayout if our control is using the maximum or range policy. - if ( ( mImpl->mHeightPolicy == Toolkit::Control::Maximum ) || ( mImpl->mWidthPolicy == Toolkit::Control::Maximum ) || - ( mImpl->mHeightPolicy == Toolkit::Control::Range ) || ( mImpl->mWidthPolicy == Toolkit::Control::Range ) ) - { - RelayoutRequest(); - } + if ( (type & Gesture::Pan) && !mImpl->mPanGestureDetector ) + { + mImpl->mPanGestureDetector = PanGestureDetector::New(); + mImpl->mPanGestureDetector.DetectedSignal().Connect(mImpl, &Impl::PanDetected); + mImpl->mPanGestureDetector.Attach(Self()); } -} -const Vector3& Control::GetMaximumSize() const -{ - return mImpl->GetMaximumSize(); -} + if ( (type & Gesture::Tap) && !mImpl->mTapGestureDetector ) + { + mImpl->mTapGestureDetector = TapGestureDetector::New(); + mImpl->mTapGestureDetector.DetectedSignal().Connect(mImpl, &Impl::TapDetected); + mImpl->mTapGestureDetector.Attach(Self()); + } -Vector3 Control::GetNaturalSize() -{ - // could be overridden in derived classes. - return mImpl->mNaturalSize; + if ( (type & Gesture::LongPress) && !mImpl->mLongPressGestureDetector ) + { + mImpl->mLongPressGestureDetector = LongPressGestureDetector::New(); + mImpl->mLongPressGestureDetector.DetectedSignal().Connect(mImpl, &Impl::LongPressDetected); + mImpl->mLongPressGestureDetector.Attach(Self()); + } } -float Control::GetHeightForWidth( float width ) +void Control::DisableGestureDetection(Gesture::Type type) { - // could be overridden in derived classes. - float height( 0.0f ); - if ( mImpl->mNaturalSize.width > 0.0f ) + if ( (type & Gesture::Pinch) && mImpl->mPinchGestureDetector ) { - height = mImpl->mNaturalSize.height * width / mImpl->mNaturalSize.width; + mImpl->mPinchGestureDetector.Detach(Self()); + mImpl->mPinchGestureDetector.Reset(); } - return height; -} -float Control::GetWidthForHeight( float height ) -{ - // could be overridden in derived classes. - float width( 0.0f ); - if ( mImpl->mNaturalSize.height > 0.0f ) + if ( (type & Gesture::Pan) && mImpl->mPanGestureDetector ) { - width = mImpl->mNaturalSize.width * height / mImpl->mNaturalSize.height; + mImpl->mPanGestureDetector.Detach(Self()); + mImpl->mPanGestureDetector.Reset(); } - return width; -} -const Vector3& Control::GetControlSize() const -{ - return mImpl->mCurrentSize; -} - -const Vector3& Control::GetSizeSet() const -{ - return mImpl->mNaturalSize; -} - -void Control::SetKeyInputFocus() -{ - if( Self().OnStage() ) - { - Toolkit::KeyInputFocusManager::Get().SetFocus(Toolkit::Control::DownCast(Self())); - } -} - -bool Control::HasKeyInputFocus() -{ - bool result = false; - if( Self().OnStage() ) + if ( (type & Gesture::Tap) && mImpl->mTapGestureDetector ) { - result = Toolkit::KeyInputFocusManager::Get().IsKeyboardListener(Toolkit::Control::DownCast(Self())); + mImpl->mTapGestureDetector.Detach(Self()); + mImpl->mTapGestureDetector.Reset(); } - return result; -} -void Control::ClearKeyInputFocus() -{ - if( Self().OnStage() ) + if ( (type & Gesture::LongPress) && mImpl->mLongPressGestureDetector) { - Toolkit::KeyInputFocusManager::Get().RemoveFocus(Toolkit::Control::DownCast(Self())); + mImpl->mLongPressGestureDetector.Detach(Self()); + mImpl->mLongPressGestureDetector.Reset(); } } @@ -1182,18 +1178,6 @@ void Control::RelayoutRequest() } } -void Control::Relayout(Vector2 size, ActorSizeContainer& container) -{ - // Avoids relayout again when OnSizeSet callback arrives. - mImpl->mInsideRelayout = true; - Self().SetSize( size ); - // @todo this really needs to be at the end of method but not sure why the scope used to be only the SetSize, needs to be cleaned up in size negotiation rework - mImpl->mInsideRelayout = false; - - // Only relayout controls which requested to be relaid out. - OnRelaidOut( size, container ); -} - void Control::Relayout( Actor actor, Vector2 size, ActorSizeContainer& container ) { if ( actor ) @@ -1210,6 +1194,71 @@ void Control::Relayout( Actor actor, Vector2 size, ActorSizeContainer& container } } +void Control::OnInitialize() +{ +} + +void Control::OnActivated() +{ +} + +void Control::OnThemeChange( Toolkit::StyleManager styleManager ) +{ + GetImpl( styleManager ).ApplyThemeStyle( GetOwner() ); +} + +void Control::OnFontChange( bool defaultFontChange, bool defaultFontSizeChange ) +{ +} + +void Control::OnPinch(const PinchGesture& pinch) +{ + if( !( mImpl->mStartingPinchScale ) ) + { + // lazy allocate + mImpl->mStartingPinchScale = new Vector3; + } + + if( pinch.state == Gesture::Started ) + { + *( mImpl->mStartingPinchScale ) = Self().GetCurrentScale(); + } + + Self().SetScale( *( mImpl->mStartingPinchScale ) * pinch.scale ); +} + +void Control::OnPan( const PanGesture& pan ) +{ +} + +void Control::OnTap(const TapGesture& tap) +{ +} + +void Control::OnLongPress( const LongPressGesture& longPress ) +{ +} + +void Control::OnControlStageConnection() +{ +} + +void Control::OnControlStageDisconnection() +{ +} + +void Control::OnControlChildAdd( Actor& child ) +{ +} + +void Control::OnControlChildRemove( Actor& child ) +{ +} + +void Control::OnControlSizeSet( const Vector3& size ) +{ +} + void Control::OnRelaidOut( Vector2 size, ActorSizeContainer& container ) { unsigned int numChildren = Self().GetChildCount(); @@ -1220,131 +1269,106 @@ void Control::OnRelaidOut( Vector2 size, ActorSizeContainer& container ) } } -void Control::NegotiateSize( Vector2 allocatedSize, ActorSizeContainer& container ) +void Control::OnKeyInputFocusGained() { - Vector2 size; + // Do Nothing +} - if ( mImpl->mWidthPolicy == Toolkit::Control::Fixed ) - { - if ( mImpl->mHeightPolicy == Toolkit::Control::Fixed ) - { - // If a control says it has a fixed size, then use the size set by the application / control. - Vector2 setSize( mImpl->mNaturalSize ); - if ( setSize != Vector2::ZERO ) - { - size = setSize; +void Control::OnKeyInputFocusLost() +{ + // Do Nothing +} - // Policy is set to Fixed, so if the application / control has not set one of the dimensions, - // then we should use the natural size of the control rather than the full allocation. - if ( EqualsZero( size.width ) ) - { - size.width = GetWidthForHeight( size.height ); - } - else if ( EqualsZero( size.height ) ) - { - size.height = GetHeightForWidth( size.width ); - } - } - else - { - // If that is not set then set the size to the control's natural size - size = Vector2( GetNaturalSize() ); - } - } - else - { - // Width is fixed so if the application / control has set it, then use that. - if ( !EqualsZero( mImpl->mNaturalSize.width ) ) - { - size.width = mImpl->mNaturalSize.width; - } - else - { - // Otherwise, set the width to what has been allocated. - size.width = allocatedSize.width; - } +void Control::OnSizeAnimation(Animation& animation, const Vector3& targetSize) +{ + // @todo consider animating negotiated child sizes to target size +} - // Height is flexible so ask control what the height should be for our width. - size.height = GetHeightForWidth( size.width ); +bool Control::OnTouchEvent(const TouchEvent& event) +{ + return false; // Do not consume +} - // Ensure height is within our policy rules - size.height = Calculate( mImpl->mHeightPolicy, GetMinimumSize().height, GetMaximumSize().height, size.height ); - } - } - else - { - if ( mImpl->mHeightPolicy == Toolkit::Control::Fixed ) - { - // Height is fixed so if the application / control has set it, then use that. - if ( !EqualsZero( mImpl->mNaturalSize.height ) ) - { - size.height = mImpl->mNaturalSize.height; - } - else - { - // Otherwise, set the height to what has been allocated. - size.height = allocatedSize.height; - } +bool Control::OnHoverEvent(const HoverEvent& event) +{ + return false; // Do not consume +} - // Width is flexible so ask control what the width should be for our height. - size.width = GetWidthForHeight( size.height ); +bool Control::OnKeyEvent(const KeyEvent& event) +{ + return false; // Do not consume +} - // Ensure width is within our policy rules - size.width = Calculate( mImpl->mWidthPolicy, mImpl->GetMinimumSize().width, mImpl->GetMaximumSize().width, size.width ); - } - else - { - // Width and height are BOTH flexible. - // Calculate the width and height using the policy rules. - size.width = Calculate( mImpl->mWidthPolicy, mImpl->GetMinimumSize().width, mImpl->GetMaximumSize().width, allocatedSize.width ); - size.height = Calculate( mImpl->mHeightPolicy, mImpl->GetMinimumSize().height, mImpl->GetMaximumSize().height, allocatedSize.height ); - } - } +bool Control::OnMouseWheelEvent(const MouseWheelEvent& event) +{ + return false; // Do not consume +} - // If the width has not been set, then set to the allocated width. - // Also if the width set is greater than the allocated, then set to allocated (no exceed support). - if ( EqualsZero( size.width ) || ( size.width > allocatedSize.width ) ) - { - size.width = allocatedSize.width; - } +Actor Control::GetChildByAlias(const std::string& actorAlias) +{ + return Actor(); +} - // If the height has not been set, then set to the allocated height. - // Also if the height set is greater than the allocated, then set to allocated (no exceed support). - if ( EqualsZero( size.height ) || ( size.height > allocatedSize.height ) ) +void Control::OnStageConnection() +{ + RelayoutRequest(); + + // Notify derived classes. + OnControlStageConnection(); +} + +void Control::OnStageDisconnection() +{ + // Notify derived classes + OnControlStageDisconnection(); +} + +void Control::OnChildAdd(Actor& child) +{ + // If this is the background actor, then we do not want to relayout or inform deriving classes + if ( mImpl->mBackground && ( child == mImpl->mBackground->actor ) ) { - size.height = allocatedSize.height; + return; } - DALI_LOG_INFO( gLogFilter, Debug::Verbose, - "%p: Natural: [%.2f, %.2f] Allocated: [%.2f, %.2f] Set: [%.2f, %.2f]\n", - Self().GetObjectPtr(), - GetNaturalSize().x, GetNaturalSize().y, - allocatedSize.x, allocatedSize.y, - size.x, size.y ); + // Request for relayout as we may need to position the new child and old ones + RelayoutRequest(); - Relayout( size, container ); + // Notify derived classes. + OnControlChildAdd( child ); } -bool Control::EmitKeyEventSignal( const KeyEvent& event ) +void Control::OnChildRemove(Actor& child) { - // Guard against destruction during signal emission - Dali::Toolkit::Control handle( GetOwner() ); + // If this is the background actor, then we do not want to relayout or inform deriving classes + if ( mImpl->mBackground && ( child == mImpl->mBackground->actor ) ) + { + return; + } - bool consumed = false; + // Request for relayout as we may need to re-position the old child + RelayoutRequest(); - // signals are allocated dynamically when someone connects - if ( !mImpl->mKeyEventSignalV2.Empty() ) + // Notify derived classes. + OnControlChildRemove( child ); +} + +void Control::OnSizeSet(const Vector3& targetSize) +{ + if( ( !mImpl->mInsideRelayout ) && ( targetSize != mImpl->mNaturalSize ) ) { - consumed = mImpl->mKeyEventSignalV2.Emit( handle, event ); + // Only updates size if set through Actor's API + mImpl->mNaturalSize = targetSize; } - if (!consumed) + if( targetSize != mImpl->mCurrentSize ) { - // Notification for derived classes - consumed = OnKeyEvent(event); - } + // Update control size. + mImpl->mCurrentSize = targetSize; - return consumed; + // Notify derived classes. + OnControlSizeSet( targetSize ); + } } void Control::SignalConnected( SlotObserver* slotObserver, CallbackBase* callback ) @@ -1357,11 +1381,28 @@ void Control::SignalDisconnected( SlotObserver* slotObserver, CallbackBase* call mImpl->SignalDisconnected( slotObserver, callback ); } -Control::Control( ControlBehaviour behaviourFlags ) -: CustomActorImpl( behaviourFlags & REQUIRES_TOUCH_EVENTS ), - mImpl(new Impl(*this)) +void Control::DoStyleChange( Toolkit::StyleManager styleManager, StyleChange change ) { - mImpl->mFlags = behaviourFlags; + if( change.themeChange ) + { + OnThemeChange( styleManager ); + } + else if( change.defaultFontChange || change.defaultFontSizeChange ) + { + OnFontChange( change.defaultFontChange, change.defaultFontSizeChange ); + } +} + +void Control::Relayout(Vector2 size, ActorSizeContainer& container) +{ + // Avoids relayout again when OnSizeSet callback arrives. + mImpl->mInsideRelayout = true; + Self().SetSize( size ); + // @todo this really needs to be at the end of method but not sure why the scope used to be only the SetSize, needs to be cleaned up in size negotiation rework + mImpl->mInsideRelayout = false; + + // Only relayout controls which requested to be relaid out. + OnRelaidOut( size, container ); } } // namespace Internal diff --git a/base/dali-toolkit/public-api/controls/control-impl.h b/base/dali-toolkit/public-api/controls/control-impl.h index 470fb27..1e095bf 100644 --- a/base/dali-toolkit/public-api/controls/control-impl.h +++ b/base/dali-toolkit/public-api/controls/control-impl.h @@ -69,132 +69,104 @@ public: CONTROL_PROPERTY_END_INDEX = CONTROL_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices }; - // Creation + // Creation & Destruction /** * @brief Create a new ControlImpl instance that does not require touch by default. * * If touch is required then the user can connect to this class' touch signal. - * @return A handle to the ConntrolImpl instance. + * @return A handle to the ControlImpl instance. */ static Toolkit::Control New(); - // Destruction - /** * @brief Virtual destructor. */ virtual ~Control(); - // Actions + // Size negotiation /** - * @brief This method should be overridden by deriving classes when they wish to be notified when they - * are activated. + * @copydoc Toolkit::Control::SetSizePolicy() */ - virtual void OnActivated() { } + void SetSizePolicy( Toolkit::Control::SizePolicy widthPolicy, Toolkit::Control::SizePolicy heightPolicy ); /** - * @brief This method should be overridden by deriving classes when they wish to respond the accessibility - * pan gesture. - * - * @param[in] gesture The pan gesture. - * @return true if the pan gesture has been consumed by this control + * @copydoc Toolkit::Control::GetSizePolicy() */ - virtual bool OnAccessibilityPan(PanGesture gesture); + void GetSizePolicy( Toolkit::Control::SizePolicy& widthPolicy, Toolkit::Control::SizePolicy& heightPolicy ) const; /** - * @brief This method should be overridden by deriving classes when they wish to respond the accessibility - * touch event. - * - * @param[in] touchEvent The touch event. - * @return true if the touch event has been consumed by this control + * @copydoc Toolkit::Control::SetMinimumSize() */ - virtual bool OnAccessibilityTouch(const TouchEvent& touchEvent); + void SetMinimumSize( const Vector3& size ); /** - * @brief This method should be overridden by deriving classes when they wish to respond - * the accessibility up and down action (i.e. value change of slider control). - * - * @param[in] isIncrease Whether the value should be increased or decreased - * @return true if the value changed action has been consumed by this control + * @copydoc Toolkit::Control::GetMinimumSize() */ - virtual bool OnAccessibilityValueChange(bool isIncrease); + const Vector3& GetMinimumSize() const; /** - * @brief Sets whether this control supports two dimensional - * keyboard navigation (i.e. whether it knows how to handle the - * keyboardn focus movement between its child actors). - * - * The control doesn't support it by default. - * @param[in] isSupported Whether this control supports two dimensional keyboard navigation. + * @copydoc Toolkit::Control::SetMaximumSize() */ - void SetKeyboardNavigationSupport(bool isSupported); + void SetMaximumSize( const Vector3& size ); /** - * @brief Gets whether this control supports two dimensional keyboard navigation. - * - * @return true if this control supports two dimensional keyboard navigation. + * @copydoc Toolkit::Control::GetMaximumSize() */ - bool IsKeyboardNavigationSupported(); + const Vector3& GetMaximumSize() const; /** - * @brief Sets whether this control is a focus group for keyboard navigation. - * - * (i.e. the scope of keyboard focus movement - * can be limitied to its child actors). The control is not a focus group by default. - * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation. + * @copydoc Toolkit::Control::GetNaturalSize() */ - void SetAsKeyboardFocusGroup(bool isFocusGroup); + virtual Vector3 GetNaturalSize(); /** - * @brief Gets whether this control is a focus group for keyboard navigation. + * @brief This method is called during size negotiation when a height is required for a given width. * - * @return true if this control is set as a focus group for keyboard navigation. + * Derived classes should override this if they wish to customize the height returned. */ - bool IsKeyboardFocusGroup(); + virtual float GetHeightForWidth( float width ); /** - * @brief Gets the next keyboard focusable actor in this control towards the given direction. + * @brief This method is called during size negotiation when a width is required for a given height. * - * A control needs to override this function in order to support two dimensional keyboard navigation. - * @param[in] currentFocusedActor The current focused actor. - * @param[in] direction The direction to move the focus towards. - * @param[in] loopEnabled Whether the focus movement should be looped within the control. - * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused. + * Derived classes should override this if they wish to customize the width returned. */ - virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled); + virtual float GetWidthForHeight( float height ); /** - * @brief Informs this control that its chosen focusable actor will be focused. - * - * This allows the application to preform any actions if wishes - * before the focus is actually moved to the chosen actor. + * @brief Retrieves the current Control's size. * - * @param[in] commitedFocusableActor The commited focusable actor. + * @return The control's size. */ - virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor) { } + const Vector3& GetControlSize() const; /** - * @brief Performs actions as requested using the action name. + * @brief Retrieves the Control's size set by the Application / Control. * - * @param[in] object The object on which to perform the action. - * @param[in] actionName The action to perform. - * @param[in] attributes The attributes with which to perfrom this action. - * @return true if action has been accepted by this control + * @return The control's size. */ - static bool DoAction(BaseObject* object, const std::string& actionName, const PropertyValueContainer& attributes); + const Vector3& GetSizeSet() const; + + // Key Input /** - * Connects a callback function with the object's signals. - * @param[in] object The object providing the signal. - * @param[in] tracker Used to disconnect the signal. - * @param[in] signalName The signal to connect to. - * @param[in] functor A newly allocated FunctorDelegate. - * @return True if the signal was connected. - * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor. + * @copydoc Toolkit::Control::SetKeyInputFocus() */ - static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor ); + void SetKeyInputFocus(); + + /** + * @copydoc Toolkit::Control::HasKeyInputFocus() + */ + bool HasKeyInputFocus(); + + /** + * @copydoc Toolkit::Control::ClearKeyInputFocus() + */ + void ClearKeyInputFocus(); + + // Gesture Detection /** * @brief If deriving classes wish to fine tune pinch gesture @@ -267,17 +239,172 @@ public: */ Actor GetBackgroundActor() const; -public: + // Keyboard Navigation + + /** + * @brief Sets whether this control supports two dimensional + * keyboard navigation (i.e. whether it knows how to handle the + * keyboardn focus movement between its child actors). + * + * The control doesn't support it by default. + * @param[in] isSupported Whether this control supports two dimensional keyboard navigation. + */ + void SetKeyboardNavigationSupport(bool isSupported); + + /** + * @brief Gets whether this control supports two dimensional keyboard navigation. + * + * @return true if this control supports two dimensional keyboard navigation. + */ + bool IsKeyboardNavigationSupported(); + + // Called by Focus Managers + + /** + * @brief Called by the focus manager and keyboard focus manager to Activate the Control + */ + DALI_INTERNAL void Activate(); + + /** + * @brief This method should be overridden by deriving classes when they wish to respond the accessibility + * pan gesture. + * + * @param[in] gesture The pan gesture. + * @return true if the pan gesture has been consumed by this control + */ + virtual bool OnAccessibilityPan(PanGesture gesture); + + /** + * @brief This method should be overridden by deriving classes when they wish to respond the accessibility + * touch event. + * + * @param[in] touchEvent The touch event. + * @return true if the touch event has been consumed by this control + */ + virtual bool OnAccessibilityTouch(const TouchEvent& touchEvent); + + /** + * @brief This method should be overridden by deriving classes when they wish to respond + * the accessibility up and down action (i.e. value change of slider control). + * + * @param[in] isIncrease Whether the value should be increased or decreased + * @return true if the value changed action has been consumed by this control + */ + virtual bool OnAccessibilityValueChange(bool isIncrease); + + // Called by the RelayoutController + + /** + * @brief Called by the RelayoutController to negotiate the size of a control. + * + * The size allocated by the the algorithm is passed in which the + * control must adhere to. A container is passed in as well which + * the control should populate with actors it has not / or does not + * need to handle in its size negotiation. + * + * @param[in] size The allocated size. + * @param[in,out] container The container that holds actors that are fed back into the + * RelayoutController algorithm. + */ + DALI_INTERNAL void NegotiateSize( Vector2 size, ActorSizeContainer& container ); + + // Keyboard Focus + + /** + * @brief Sets whether this control is a focus group for keyboard navigation. + * + * (i.e. the scope of keyboard focus movement + * can be limitied to its child actors). The control is not a focus group by default. + * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation. + */ + void SetAsKeyboardFocusGroup(bool isFocusGroup); + + /** + * @brief Gets whether this control is a focus group for keyboard navigation. + * + * @return true if this control is set as a focus group for keyboard navigation. + */ + bool IsKeyboardFocusGroup(); + + /** + * @brief Gets the next keyboard focusable actor in this control towards the given direction. + * + * A control needs to override this function in order to support two dimensional keyboard navigation. + * @param[in] currentFocusedActor The current focused actor. + * @param[in] direction The direction to move the focus towards. + * @param[in] loopEnabled Whether the focus movement should be looped within the control. + * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused. + */ + virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled); + + /** + * @brief Informs this control that its chosen focusable actor will be focused. + * + * This allows the application to preform any actions if wishes + * before the focus is actually moved to the chosen actor. + * + * @param[in] commitedFocusableActor The commited focusable actor. + */ + virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor); + + // Actions & Signals + + /** + * @brief Performs actions as requested using the action name. + * + * @param[in] object The object on which to perform the action. + * @param[in] actionName The action to perform. + * @param[in] attributes The attributes with which to perfrom this action. + * @return true if action has been accepted by this control + */ + static bool DoAction(BaseObject* object, const std::string& actionName, const PropertyValueContainer& attributes); + + /** + * Connects a callback function with the object's signals. + * @param[in] object The object providing the signal. + * @param[in] tracker Used to disconnect the signal. + * @param[in] signalName The signal to connect to. + * @param[in] functor A newly allocated FunctorDelegate. + * @return True if the signal was connected. + * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor. + */ + static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor ); /** * @copydoc Dali::Toolkit::Control::KeyEventSignal() */ Toolkit::Control::KeyEventSignalV2& KeyEventSignal(); + /** + * @brief Called by the KeyInputFocusManager to emit key event signals. + * + * @param[in] event The key event. + * @return True if the event was consumed. + */ + DALI_INTERNAL bool EmitKeyEventSignal(const KeyEvent& event); + protected: // Construction + // Flags for the constructor + enum ControlBehaviour + { + CONTROL_BEHAVIOUR_NONE = 0, + REQUIRES_TOUCH_EVENTS = 1<<1, ///< True if the OnTouchEvent() callback is required. + REQUIRES_STYLE_CHANGE_SIGNALS = 1<<2, ///< True if needs to monitor style change signals such as theme/font change + NO_SIZE_NEGOTIATION = 1<<3, ///< True if control does not need size negotiation, i.e. it can be skipped in the algorithm + REQUIRES_HOVER_EVENTS = 1<<4, ///< True if the OnHoverEvent() callback is required. + REQUIRES_MOUSE_WHEEL_EVENTS = 1<<5 ///< True if the OnMouseWheelEvent() callback is required. + }; + + /** + * @brief Create a Control. + * + * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum + */ + Control(ControlBehaviour behaviourFlags); + /** * @brief Second phase initialization. */ @@ -297,23 +424,63 @@ protected: void EnableGestureDetection(Gesture::Type type); /** - * @brief Allows deriving classes to disable any of the gesture detectors. + * @brief Allows deriving classes to disable any of the gesture detectors. + * + * Like EnableGestureDetection, this can also be called using bitwise or. + * @param[in] type The gesture type(s) to disable. + * @see EnableGetureDetection + */ + void DisableGestureDetection(Gesture::Type type); + + // Size Negotiation + + /** + * @brief Sends a request to be relaid-out. + * + * This method is called from OnStageConnection(), OnChildAdd(), + * OnChildRemove(), SetSizePolicy(), SetMinimumSize() and + * SetMaximumSize(). + * + * This method could also be called from derived classes every time + * a control's poperty change and it needs to be relaid-out. After + * the Dali::Stage::SignalMessageQueueFlushed() is emitted a + * relayout process starts and all controls which called this method + * will be relaid-out. + * + * @note RelayoutRequest() only sends a request per Control before + * the Dali::Stage::SignalMessageQueueFlushed() signal is + * emitted. That means a control will be relaid-out only once, even + * if more than one request is sent between two consecutive signals. + */ + void RelayoutRequest(); + + /** + * @brief Helper method for controls to Relayout their children if + * they do not know whether that child is a control or not. * - * Like EnableGestureDetection, this can also be called using bitwise or. - * @param[in] type The gesture type(s) to disable. - * @see EnableGetureDetection + * @param[in] actor The actor to relayout. + * @param[in] size The size to allocate to the actor. + * @param[in,out] container The container that holds actors that have not been allocated a size yet. */ - void DisableGestureDetection(Gesture::Type type); + static void Relayout( Actor actor, Vector2 size, ActorSizeContainer& container ); -private: // For derived classes to override +private: + + // For derived classes to override /** * @brief This method is called after the Control has been initialized. * - * Derived classes should do any second phase initialization by - * overriding this method. + * Derived classes should do any second phase initialization by overriding this method. + */ + virtual void OnInitialize(); + + /** + * @brief This method is called when the control is activates. + * + * Derived classes should override this if they wish to be notified when they are activated. */ - virtual void OnInitialize() { } + virtual void OnActivated(); /** * @brief This method should be overridden by deriving classes when @@ -330,7 +497,7 @@ private: // For derived classes to override * @param[in] defaultFontChange Information denoting whether the default font has changed. * @param[in] defaultFontSizeChange Information denoting whether the default font size has changed. */ - virtual void OnFontChange( bool defaultFontChange, bool defaultFontSizeChange ){ } + virtual void OnFontChange( bool defaultFontChange, bool defaultFontSizeChange ); /** * @brief Called whenever a pinch gesture is detected on this control. @@ -390,14 +557,14 @@ private: // For derived classes to override * * Could be overridden by derived classes. */ - virtual void OnControlStageConnection() { } + virtual void OnControlStageConnection(); /** * @brief Called whenever the control is removed from the stage. * * Could be overridden by derived classes. */ - virtual void OnControlStageDisconnection() { } + virtual void OnControlStageDisconnection(); /** * @brief Called whenever an Actor is added to the control. @@ -406,7 +573,7 @@ private: // For derived classes to override * * @param[in] child The added actor. */ - virtual void OnControlChildAdd( Actor& child ) { } + virtual void OnControlChildAdd( Actor& child ); /** * @brief Called whenever an Actor is removed from the control. @@ -415,7 +582,7 @@ private: // For derived classes to override * * @param[in] child The removed actor. */ - virtual void OnControlChildRemove( Actor& child ) { } + virtual void OnControlChildRemove( Actor& child ); /** * @brief Called whenever the Control's size is set. @@ -424,7 +591,7 @@ private: // For derived classes to override * * @param[in] size The new size. */ - virtual void OnControlSizeSet( const Vector3& size ) { } + virtual void OnControlSizeSet( const Vector3& size ); /** * @brief Called after the Dali::Stage::SignalMessageQueueFlushed() @@ -440,7 +607,53 @@ private: // For derived classes to override */ virtual void OnRelaidOut( Vector2 size, ActorSizeContainer& container ); -private: // From CustomActorImpl, derived classes can override these. + /** + * @brief Called when the control gains key input focus. + * + * Should be overridden by derived classes if they need to customize what happens when focus is gained. + */ + virtual void OnKeyInputFocusGained(); + + /** + * @brief Called when the control loses key input focus. + * + * Should be overridden by derived classes if they need to customize what happens when focus is lost. + */ + virtual void OnKeyInputFocusLost(); + + // From CustomActorImpl, derived classes can override these. + + /** + * @copydoc Dali::CustomActorImpl::OnSizeAnimation(Animation&, const Vector3&) + */ + virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize); + + /** + * @copydoc Dali::CustomActorImpl::OnTouchEvent(const TouchEvent&) + */ + virtual bool OnTouchEvent(const TouchEvent& event); + + /** + * @copydoc Dali::CustomActorImpl::OnHoverEvent(const HoverEvent&) + */ + virtual bool OnHoverEvent(const HoverEvent& event); + + /** + * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&) + */ + virtual bool OnKeyEvent(const KeyEvent& event); + + /** + * @copydoc Dali::CustomActorImpl::OnMouseWheelEvent(const MouseWheelEvent&) + */ + virtual bool OnMouseWheelEvent(const MouseWheelEvent& event); + + /** + * @copydoc Dali::CustomActorImpl::GetChildByAlias(const std::string& actorAlias) + */ + virtual Actor GetChildByAlias(const std::string& actorAlias); + + // From CustomActorImpl, derived classes should NOT override these. /** * @brief Sends a request to relayout this control. @@ -503,155 +716,7 @@ private: // From CustomActorImpl, derived classes can override these. */ virtual void OnSizeSet(const Vector3& targetSize); - /** - * @copydoc Dali::CustomActorImpl::OnSizeAnimation(Animation&, const Vector3&) - */ - virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize); - - /** - * @copydoc Dali::CustomActorImpl::OnTouchEvent(const TouchEvent&) - */ - virtual bool OnTouchEvent(const TouchEvent& event); - - /** - * @copydoc Dali::CustomActorImpl::OnHoverEvent(const HoverEvent&) - */ - virtual bool OnHoverEvent(const HoverEvent& event); - - /** - * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&) - */ - virtual bool OnKeyEvent(const KeyEvent& event); - - /** - * @copydoc Dali::CustomActorImpl::OnMouseWheelEvent(const MouseWheelEvent&) - */ - virtual bool OnMouseWheelEvent(const MouseWheelEvent& event); - - /** - * @copydoc Dali::CustomActorImpl::OnKeyInputFocusGained() - */ - virtual void OnKeyInputFocusGained(); - - /** - * @copydoc Dali::CustomActorImpl::OnKeyInputFocusLost() - */ - virtual void OnKeyInputFocusLost(); - - /** - * @copydoc Dali::CustomActorImpl::GetChildByAlias(const std::string& actorAlias) - */ - virtual Actor GetChildByAlias(const std::string& actorAlias); - -private: - - /** - * @brief This method is the callback for the StyleChangeSignal from StyleManager - * - * @param[in] styleManager The StyleManager Object - * @param[in] change Information denoting what has changed. - */ - DALI_INTERNAL void DoStyleChange( Toolkit::StyleManager styleManager, StyleChange change ); - -protected: // Construction - - // Flags for the constructor - enum ControlBehaviour - { - CONTROL_BEHAVIOUR_NONE = 0, - REQUIRES_TOUCH_EVENTS = 1<<1, ///< True if the OnTouchEvent() callback is required. - REQUIRES_STYLE_CHANGE_SIGNALS = 1<<2, ///< True if needs to monitor style change signals such as theme/font change - NO_SIZE_NEGOTIATION = 1<<3, ///< True if control does not need size negotiation, i.e. it can be skipped in the algorithm - REQUIRES_HOVER_EVENTS = 1<<4, ///< True if the OnHoverEvent() callback is required. - REQUIRES_MOUSE_WHEEL_EVENTS = 1<<5 ///< True if the OnMouseWheelEvent() callback is required. - }; - - /** - * @brief Create a Control. - * - * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum - */ - Control(ControlBehaviour behaviourFlags); - -public: - - // Size negotiation - - /** - * @copydoc Toolkit::Control::SetSizePolicy() - */ - void SetSizePolicy( Toolkit::Control::SizePolicy widthPolicy, Toolkit::Control::SizePolicy heightPolicy ); - - /** - * @copydoc Toolkit::Control::GetSizePolicy() - */ - void GetSizePolicy( Toolkit::Control::SizePolicy& widthPolicy, Toolkit::Control::SizePolicy& heightPolicy ) const; - - /** - * @copydoc Toolkit::Control::SetMinimumSize() - */ - void SetMinimumSize( const Vector3& size ); - - /** - * @copydoc Toolkit::Control::GetMinimumSize() - */ - const Vector3& GetMinimumSize() const; - - /** - * @copydoc Toolkit::Control::SetMaximumSize() - */ - void SetMaximumSize( const Vector3& size ); - - /** - * @copydoc Toolkit::Control::GetMaximumSize() - */ - const Vector3& GetMaximumSize() const; - - /** - * @copydoc Toolkit::Control::GetNaturalSize() - */ - virtual Vector3 GetNaturalSize(); - - /** - * @copydoc Toolkit::Control::GetHeightForWidth() - */ - virtual float GetHeightForWidth( float width ); - - /** - * @copydoc Toolkit::Control::GetWidthForHeight() - */ - virtual float GetWidthForHeight( float height ); - - /** - * @brief Retrieves the current Control's size. - * - * @return The control's size. - */ - const Vector3& GetControlSize() const; - - /** - * @brief Retrieves the Control's size set by the Application / Control. - * - * @return The control's size. - */ - const Vector3& GetSizeSet() const; - - //KeyInput - - /** - * @copydoc Toolkit::Control::SetKeyInputFocus() - */ - void SetKeyInputFocus(); - - /** - * @copydoc Toolkit::Control::HasKeyInputFocus() - */ - bool HasKeyInputFocus(); - - /** - * @copydoc Toolkit::Control::ClearKeyInputFocus() - */ - void ClearKeyInputFocus(); + // From ConnectionTrackerInterface /** * @copydoc ConnectionTrackerInterface::SignalConnected @@ -663,55 +728,17 @@ public: */ virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback ); -protected: - - /** - * @brief Sends a request to be relaid-out. - * - * This method is called from OnStageConnection(), OnChildAdd(), - * OnChildRemove(), SetSizePolicy(), SetMinimumSize() and - * SetMaximumSize(). - * - * This method could also be called from derived classes every time - * a control's poperty change and it needs to be relaid-out. After - * the Dali::Stage::SignalMessageQueueFlushed() is emitted a - * relayout process starts and all controls which called this method - * will be relaid-out. - * - * @note RelayoutRequest() only sends a request per Control before - * the Dali::Stage::SignalMessageQueueFlushed() signal is - * emitted. That means a control will be relaid-out only once, even - * if more than one request is sent between two consecutive signals. - */ - void RelayoutRequest(); - - /** - * @brief Helper method for controls to Relayout their children if - * they do not know whether that child is a control or not. - * - * @param[in] actor The actor to relayout. - * @param[in] size The size to allocate to the actor. - * @param[in,out] container The container that holds actors that have not been allocated a size yet. - */ - static void Relayout( Actor actor, Vector2 size, ActorSizeContainer& container ); - -private: // Used by the RelayoutController + // Style /** - * @brief Called by the RelayoutController to negotiate the size of a control. - * - * The size allocated by the the algorithm is passed in which the - * control must adhere to. A container is passed in as well which - * the control should populate with actors it has not / or does not - * need to handle in its size negotiation. + * @brief This method is the callback for the StyleChangeSignal from StyleManager * - * @param[in] size The allocated size. - * @param[in,out] container The container that holds actors that are fed back into the - * RelayoutController algorithm. + * @param[in] styleManager The StyleManager Object + * @param[in] change Information denoting what has changed. */ - DALI_INTERNAL void NegotiateSize( Vector2 size, ActorSizeContainer& container ); + DALI_INTERNAL void DoStyleChange( Toolkit::StyleManager styleManager, StyleChange change ); -private: + // Size Negotiation /** * @brief Called by NegotiateSize when the size to allocate to the control has been calculated. @@ -724,14 +751,6 @@ private: */ DALI_INTERNAL void Relayout( Vector2 size, ActorSizeContainer& container ); - /** - * @brief Used by the KeyInputFocusManager to emit key event signals. - * - * @param[in] event The key event. - * @return True if the event was consumed. - */ - DALI_INTERNAL bool EmitKeyEventSignal(const KeyEvent& event); - private: // Undefined @@ -741,8 +760,7 @@ private: class Impl; Impl* mImpl; - friend class Internal::RelayoutControllerImpl; ///< Relayout controller needs to call Relayout() which is private. - friend class Internal::KeyInputFocusManager; ///< KeyInputFocusManager needs to call which is private. + friend class Internal::KeyInputFocusManager; ///< KeyInputFocusManager needs to call several methods which are private. // TODO: Remove }; } // namespace Internal diff --git a/base/dali-toolkit/public-api/controls/control.h b/base/dali-toolkit/public-api/controls/control.h index 1500115..8d4d732 100644 --- a/base/dali-toolkit/public-api/controls/control.h +++ b/base/dali-toolkit/public-api/controls/control.h @@ -297,7 +297,7 @@ public: * @brief Retrieves the pinch gesture detector of the control. * * @return The pinch gesture detector. - * @pre Pinch detection should have been enabled in the control. + * @note Will return an empty handle if the control does not handle the gesture itself. */ PinchGestureDetector GetPinchGestureDetector() const; @@ -305,7 +305,7 @@ public: * @brief Retrieves the pan gesture detector of the control. * * @return The pan gesture detector. - * @pre Pan detection should have been enabled in the control. + * @note Will return an empty handle if the control does not handle the gesture itself. */ PanGestureDetector GetPanGestureDetector() const; @@ -313,7 +313,7 @@ public: * @brief Retrieves the tap gesture detector of the control. * * @return The tap gesture detector. - * @pre Tap detection should have been enabled in the control. + * @note Will return an empty handle if the control does not handle the gesture itself. */ TapGestureDetector GetTapGestureDetector() const; @@ -321,7 +321,7 @@ public: * @brief Retrieves the long press gesture detector of the control. * * @return The long press gesture detector. - * @pre Long press detection should have been enabled in the control. + * @note Will return an empty handle if the control does not handle the gesture itself. */ LongPressGestureDetector GetLongPressGestureDetector() const; diff --git a/build/tizen/docs/dali.doxy.in b/build/tizen/docs/dali.doxy.in index 762e66c..33e5418 100644 --- a/build/tizen/docs/dali.doxy.in +++ b/build/tizen/docs/dali.doxy.in @@ -1,90 +1,114 @@ -# Doxyfile 1.5.8 +# Doxyfile 1.8.6 # This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project +# doxygen (www.doxygen.org) for a project. # -# All text after a hash (#) is considered a comment and will be ignored +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. # The format is: -# TAG = value [value, ...] -# For lists items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" ") +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# http://www.gnu.org/software/libiconv for the list of possible encodings. +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded -# by quotes) that should identify the project. +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. PROJECT_NAME = Dali -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. PROJECT_NUMBER = -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location -# where doxygen was started. If left blank the current directory will be used. +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. OUTPUT_DIRECTORY = @DOXYGEN_DOCS_DIR@/generated -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. CREATE_SUBDIRS = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, -# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, -# Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, Slovene, -# Spanish, Swedish, and Ukrainian. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. +# The default value is: YES. REPEAT_BRIEF = YES -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" -# "represents" "a" "an" "the" +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = "The $name class" \ "The $name widget" \ @@ -99,8 +123,9 @@ ABBREVIATE_BRIEF = "The $name class" \ the # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief +# doxygen will generate a detailed section even if there is only a brief # description. +# The default value is: NO. ALWAYS_DETAILED_SEC = NO @@ -108,152 +133,204 @@ ALWAYS_DETAILED_SEC = NO # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. +# The default value is: NO. INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. FULL_PATH_NAMES = YES -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the -# path to strip. +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = . -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that -# are normally passed to the compiler using the -I flag. +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. STRIP_FROM_INC_PATH = -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful is your file systems -# doesn't support long names like on DOS, Mac, or CD-ROM. +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. SHORT_NAMES = NO -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. JAVADOC_AUTOBRIEF = YES -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. QT_AUTOBRIEF = NO -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. INHERIT_DOCS = YES -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will -# be part of the file/class/namespace that contains it. +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. SEPARATE_MEMBER_PAGES = NO -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 2 -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. ALIASES = -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list -# of all members will be omitted, etc. +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = NO -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified -# scopes will look different, etc. +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources only. Doxygen will then generate output that is more tailored for -# Fortran. +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for -# VHDL. +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO -# Doxygen selects the parser to use depending on the extension of the files it parses. -# With this tag you can assign which parser to use for a given extension. -# Doxygen has a built-in mapping, but you can override or extend it using this tag. -# The format is ext=language, where ext is a file extension, and language is one of -# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, -# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat -# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), -# use: inc=Fortran f=C +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. EXTENSION_MAPPING = +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also make the inheritance and collaboration +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. +# The default value is: NO. BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. +# The default value is: NO. CPP_CLI_SUPPORT = NO -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. -# Doxygen will parse them like normal C++ but will assume all classes use public -# instead of private inheritance when no explicit protection keyword is present. +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. SIP_SUPPORT = NO -# For Microsoft's IDL there are propget and propput attributes to indicate getter -# and setter methods for a property. Setting this option to YES (the default) -# will make doxygen to replace the get and set methods by a property in the -# documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the -# methods anyway, you should set this option to NO. +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. IDL_PROPERTY_SUPPORT = YES @@ -261,295 +338,420 @@ IDL_PROPERTY_SUPPORT = YES # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. +# The default value is: NO. DISTRIBUTE_GROUP_DOC = NO -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. SUBGROUPING = YES -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code in case the coding convention dictates that all compound +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. TYPEDEF_HIDES_STRUCT = NO +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. EXTRACT_ALL = YES -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. EXTRACT_PRIVATE = YES -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. EXTRACT_STATIC = YES -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. EXTRACT_LOCAL_CLASSES = YES -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default -# anonymous namespace are hidden. +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. EXTRACT_ANON_NSPACES = NO -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. HIDE_UNDOC_MEMBERS = NO -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. HIDE_UNDOC_CLASSES = NO -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the -# function's detailed documentation block. +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. HIDE_IN_BODY_DOCS = NO -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. +# The default value is: system dependent. CASE_SENSE_NAMES = NO -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. HIDE_SCOPE_NAMES = NO -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. SHOW_INCLUDE_FILES = YES -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] -# is inserted in the documentation for inline members. +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. SORT_MEMBER_DOCS = YES -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. SORT_BRIEF_DOCS = NO -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) -# the group names will appear in their defined order. +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. SORT_GROUP_NAMES = NO -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the -# alphabetical list. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. SORT_BY_SCOPE_NAME = NO -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo -# commands in the documentation. +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. GENERATE_TODOLIST = NO -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test -# commands in the documentation. +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. GENERATE_TESTLIST = NO -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug -# commands in the documentation. +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. GENERATE_BUGLIST = NO -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting -# \deprecated commands in the documentation. +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. GENERATE_DEPRECATEDLIST= YES -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. ENABLED_SECTIONS = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or define consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and defines in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the -# list will mention the files that were used to generate the documentation. +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. SHOW_USED_FILES = YES -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the -# Folder Tree View (if specified). The default is YES. +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. SHOW_FILES = YES -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. This will remove the Namespaces entry from the Quick Index -# and from the Folder Tree View (if specified). The default is YES. +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. FILE_VERSION_FILTER = -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by -# doxygen. The layout file controls the global structure of the generated output files -# in an output format independent way. The create the layout file that represents -# doxygen's defaults, run doxygen with the -l option. You can optionally specify a -# file name after the option, if omitted DoxygenLayout.xml will be used as the name -# of the layout file. +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. LAYOUT_FILE = @DOXYGEN_DOCS_DIR@/DaliLayout.xml +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + #--------------------------------------------------------------------------- -# configuration options related to warning and progress messages +# Configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. WARNINGS = YES -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. WARN_IF_UNDOCUMENTED = YES -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. WARN_IF_DOC_ERROR = YES -# This WARN_NO_PARAMDOC option can be abled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. WARN_NO_PARAMDOC = YES -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- -# configuration options related to the input files +# Configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. INPUT = @DOXYGEN_DOCS_DIR@/content \ ../../../../dali-toolkit/base/dali-toolkit/public-api \ @@ -558,19 +760,22 @@ INPUT = @DOXYGEN_DOCS_DIR@/content \ @prefix@/include/dali # This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for -# the list of possible encodings. +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. FILE_PATTERNS = *.c \ *.cc \ @@ -605,30 +810,34 @@ FILE_PATTERNS = *.c \ *.vhd \ *.vhdl -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. RECURSIVE = YES -# The EXCLUDE tag can be used to specify files and/or directories that should +# The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. EXCLUDE = dali/integration-api - -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix filesystem feature) are excluded +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded # from the input. +# The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories -# for example use the pattern */test/* +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = @@ -637,6 +846,9 @@ EXCLUDE_PATTERNS = # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = DaliInternal \ Dali::Internal \ @@ -644,569 +856,1074 @@ EXCLUDE_SYMBOLS = DaliInternal \ Impl \ ApplicationImpl -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. EXAMPLE_PATTERNS = * # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. EXAMPLE_RECURSIVE = YES -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). IMAGE_PATH = @DOXYGEN_DOCS_DIR@/content/images # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be -# ignored. +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER -# is applied to all files. +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. FILTER_SOURCE_FILES = NO +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + #--------------------------------------------------------------------------- -# configuration options related to source browsing +# Configuration options related to source browsing #--------------------------------------------------------------------------- -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. SOURCE_BROWSER = YES -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. INLINE_SOURCES = NO -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES -# then for each documented function all documented -# functions referencing it will be listed. +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. REFERENCED_BY_RELATION = NO -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities -# called/used by that function will be listed. +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. REFERENCES_RELATION = NO -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. Otherwise they will link to the documentation. +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. REFERENCES_LINK_SOURCE = YES -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index +# Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. ALPHABETICAL_INDEX = NO -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- -# configuration options related to the HTML output +# Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. GENERATE_HTML = YES -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# doxygen will generate files with .html extension. +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a # standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# stylesheet in the HTML output directory as well, or it will be erased! +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the -# page has loaded. For this to work a browser that supports -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO -# If the GENERATE_DOCSET tag is set to YES, additional index files -# will be generated that can be used as input for Apple's Xcode 3 -# integrated development environment, introduced with OSX 10.5 (Leopard). -# To create a documentation set, doxygen will generate a Makefile in the -# HTML output directory. Running make will produce the docset in that -# directory and running "make install" will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find -# it at startup. -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) -# can be grouped. +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen -# will append .docset to the name. +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = YES -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be # written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = dali.chm -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER -# are set, an additional index file will be generated that can be used as input for -# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated -# HTML documentation. +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. -# The path specified is relative to the HTML output folder. +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#namespace +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#virtual-folders +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. -# For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see -# Qt Help Project / Custom Filters. +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's -# filter section matches. -# Qt Help Project / Filter Attributes. +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO -# This tag can be used to set the number of enum values (range [1..20]) -# that doxygen will group on one line in the generated HTML documentation. - -ENUM_VALUES_PER_LINE = 4 - # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to FRAME, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are -# probably better off using the HTML help feature. Other possible values -# for this tag are: HIERARCHIES, which will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list; -# ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which -# disables this behavior completely. For backwards compatibility with previous -# releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE -# respectively. +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NONE -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory -# to force them to be regenerated. +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /