HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r1447:b0784ac08186

updated legend documentation

sauimone -

r1447:b0784ac08186

parent child

Context file:

r1447:b0784ac08186

Collapse all files

doc/images/examples_legend_detach.png binary modified 0 0

NO CONTENT: modified file, binary diff hidden

doc/src/examples-legend.qdoc +11 -13

                 \subtitle
             	This example shows how to detach legend from chart and how to attach it back. By default the chart
-            	draws the legend inside same view with the chart. In some cases user may want to draw legend to somewhere else. To make this possible the legend can be detached from the chart. Detaching means that chart doesn't draw the legend or try to change it's layout. Detached can then be drawn where user wants, for example in different graphics scene. In this example we do so.
+            	draws the legend inside same view with the chart. In some cases user may want to draw legend to somewhere else. To make this possible the legend can be detached from the chart. Detaching means that chart doesn't draw the legend or try to change it's layout. Detached can then be drawn where user wants, for example in different graphics scene. The behaviour of legend can be inspected by running the legend example.
+            	In example we use barseries where we add or remove barsets. The legend reflects the changes in series. Legend can be detached or attached back to chart and its alignment can be modified.
+            	When legend is detached, it can be resized and positioned freely.
                 \image examples_legend_detach.png
-                First we create our chart as usual.
+            	Here we turn legend visible and set its alignment to the bottom of the chart.
                 \snippet ../examples/legend/mainwidget.cpp 1
-                Here we create custom graphics scene, where we want to draw the detached legend.
+                This snippet shows how to detach the legend from chart. After detaching, we turn its background to visible and set a different color to it. This makes it easier to see, how the items inside legend are arranged
+            	in detached mode.
                 \snippet ../examples/legend/mainwidget.cpp 2
-                Add some series to the chart.
+                Here we attach legend back to chart. The background is turned invisible.
                 \snippet ../examples/legend/mainwidget.cpp 3
-                Here we detach the legend. After detaching, we set new geometry for it and add it to the custom scene. The custom scene adopts the legend and becomes new parent for it. Note that chart will still update the contents of the legend.
+            	This shows how we set the detached legend dimensions. After setting new values, we call update to show changes on screen.
                 \snippet ../examples/legend/mainwidget.cpp 4
-                To attach legend back to chart we first remove it from the custom scene. Then we add legend to the scene, where chart is. Last we attach legend to chart. Attaching legend to chart automatically sets the QChart as parent for legend.
-                \snippet ../examples/legend/mainwidget.cpp 5
             */

examples/legend/mainwidget.cpp +9 -10

                 m_legendSettings->setVisible(false);
                 // Create chart view with the chart
-            //![1]
                 m_chart = new QChart();
                 m_chartView = new QChartView(m_chart, this);
-            //![1]
                 // Create layout for grid and detached legend
                 m_mainLayout = new QGridLayout();
             void MainWidget::createSeries()
             {
-            //![3]
                 m_series = new QBarSeries();
                 addBarset();
                 addBarset();
                 m_chart->addSeries(m_series);
                 m_chart->setTitle("Legend detach example");
+            //![1]
                 m_chart->legend()->setVisible(true);
                 m_chart->legend()->setAlignment(Qt::AlignBottom);
-                m_chart->axisY()->setNiceNumbersEnabled(true);
+            //![1]
+                m_chart->axisY()->setNiceNumbersEnabled(true);
                 m_chartView->setRenderHint(QPainter::Antialiasing);
-            //![3]
             }
             void MainWidget::showLegendSpinbox()
             void MainWidget::detachLegend()
             {
-            //![4]
+            //![2]
                 QLegend *legend = m_chart->legend();
                 legend->detachFromChart();
                 m_chart->legend()->setBackgroundVisible(true);
                 m_chart->legend()->setBrush(QBrush(QColor(128,128,128,128)));
-            //![4]
+            //![2]
                 showLegendSpinbox();
                 updateLegendLayout();
             void MainWidget::attachLegend()
             {
-            //![5]
+            //![3]
                 QLegend *legend = m_chart->legend();
                 legend->attachToChart();
                 m_chart->legend()->setBackgroundVisible(false);
-            //![5]
+            //![3]
                 hideLegendSpinbox();
                 update();
             void MainWidget::updateLegendLayout()
             {
+            //![4]
                 m_chart->legend()->setGeometry(m_legendPosX->value()
                                                ,m_legendPosY->value()
                                                ,m_legendWidth->value()
                                                ,m_legendHeight->value());
                 m_chart->legend()->update();
+            //![4]
             }

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages