ROOT   Reference Guide
HelpSMText.cxx
Go to the documentation of this file.
1// @(#)root/ged:$Id$
2// Author: Denis Favre-Miville 08/09/05
3
4/*************************************************************************
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. * 9 * For the list of contributors see$ROOTSYS/README/CREDITS. *
10 *************************************************************************/
11
12#include "HelpSMText.h"
13
14const char gHelpSMTopLevel[] =
15"The Style Manager handles a list of styles in the ROOT session. It loads\n"
16"by default the five styles provided by ROOT: Default, Plain, Bold, Video,\n"
17"and Pub. If this list does not contain a style with the characteristics\n"
18"you want, you can create a new one and than apply it.\n"
19"\n"
20"The Style Manager interface is composed of two parts:\n"
21" - the top level interface that manages a list of styles;\n"
22" - the style editor, which deals with the current style settings.\n"
23"\n"
24"'Available Styles':\n"
25" Contains the list of available styles for the current ROOT session and the\n"
26" currently selected one. The field on the right shows the setting of the\n"
27" gStyle. You can set the global variable gStyle to the selected style by the\n"
28" button in the middle.\n"
29"\n"
30"'Apply on':\n"
31" Displays information for the currently selected canvas and object in the\n"
32" ROOT session. This selection might be changed by clicking on another\n"
33" object with the middle mouse button. You have a choice to apply the\n"
34" selected style on the selected object or on all available canvases.\n"
35" in the ROOT session.\n"
36" WARNING: You cannot undo the changes after applying the style! If you are\n"
37" not sure of that action, it may be better to see a preview of what you are.\n"
38" going to apply.\n"
39"\n"
40"Preview\n"
41" Shows a preview of the selected canvas according to the selected style.\n"
42"\n"
43"Run Time Preview\n"
44" Updates the preview any time a value of the selected style is changed.\n"
45" For drawings that take a time it is better to disable this option.\n"
46"\n"
47"Create a new style / delete a style:\n"
48" You can access these functionalities via the menu or the tool bar.\n"
49" If you create a style, a clone of the selected style will be created;\n"
50" you will have the opportunity to modify it later via the editor.\n"
51" Moreover, during the creation process, you will be asked for a name and\n"
52" a description for your brand new style. The name can obviously not be the\n"
53" same as another already existing style.\n"
54" When you choose 'delete', the selected style is removed from the ROOT\n"
55" session. The selected style will be lost if you didn't saved it in a C++\n"
56" macro file before. Nota Bene: You are not allowed to delete gStyle.\n"
57"\n"
58"Export a style (in a C++ macro file) / Import a style (from a macro):\n"
59" To store a style longer than for one session of ROOT or in order to\n"
60" share some styles with others, you can save it in a C++ macro file.\n"
61" This can be done via the menu and the tool bar. The selected style will\n"
62" be saved. The name of the macro must be 'Style_*.C', where * can be\n"
63" replaced by anything you want.\n"
64" A style's macro can be imported at any time. The new style created\n"
65" in ROOT will become the selected style. WARNING: When a style is loaded\n"
66" from a macro, every already existing style with the same name will be\n"
67" overwritten.\n"
68"\n"
69"Apply a style (on an object) / Import a style (from an object):\n"
70" There is a specific button to apply a style on an object and its use\n"
71" has already been described in the overview.\n"
72" To import a style from a canvas, the 'Style / Import from... / Canvas'\n"
73" menu is the only way. A new style will be created in the ROOT session and\n"
74" will become the selected style. This style is a clone of gStyle where\n"
75" every style's information contained in the selected canvas (the canvas\n"
76" containing the current selected pad) is written. You can consequently\n"
77" import a style from a canvas and apply it later on another object.\n"
78"\n"
79"Preview a style:\n"
80" The predicted result when applying a style can be seen if the 'Preview'\n"
81" checkbutton is selected. The preview includes the original canvas.\n"
82"\n"
83"Editor's buttons:\n"
84" Open / close the editor:\n"
85" A specific button to open or close the editor exists in the style\n"
86" manager. Its caption is 'Edit >>' when the editor is closed and\n"
87" switches to 'Close <<' when it is opened.\n"
88" Reset a style (to a previously saved state):\n"
89" When the editor is opened, in the bottom of the main window of the\n"
90" style manager, a 'Reset' button enables you to reset the values of the\n"
91" selected style. So doing, you cancel all changes made since the last\n"
92" time you saved that style in a macro file. If the selected style is\n"
93" one of the five predefined styles of ROOT (Plain, Bold, Video, Pub or\n"
94" Default), it will be reset using the specific code in the ROOT files.\n"
95" Update the preview:\n"
96" An 'Update Preview' is also available when a preview is shown and\n"
97" the run time option is disabled. This button allows you to refresh the\n"
98" preview at any time.\n"
99;
100
101const char gHelpSMGeneral[] =
102"Sets the general style values used when creating new objects\n"
103"\n"
104"'Fill' group: \n"
105" Sets the default filling color and pattern for drawing of any new object;\n"
106" the hatchings' line width and spacing for patterns > 3100.\n"
107"\n"
108"'Text' group:\n"
109" Sets the text color, font, alignment, font size and angle.\n"
110" The font size can be specified in pixels or in % of the pad size.\n"
111"\n"
112"'Line' group:\n"
113" Sets the parameters for creating a new line: color, width and line style.\n"
114"\n"
115"'Marker' group:\n"
116" Sets the default parameters markers: color, style and size. \n"
117"\n"
118"Screen factor:\n"
119" Sets a coefficient for different screen resolutions.\n"
120" For exemple, if a macro creates a 800*600 canvas, and the screen\n"
121" factor is set to 0.8, a 640*480 canvas will be shown.\n"
122;
123
124const char gHelpSMCanvas[] =
125"Sets the style values related to the canvas objcts.\n"
126"\n"
127"'Fill' group:\n"
128" Sets the canvas fill color.\n"
129"\n"
130"'Geometry' group:\n"
131" Sets the canvas geometry:the width, the height, and the (x,y) position \n"
132" where any new canvas will be placed, by default.\n"
133"\n"
134"'Border' group:\n"
135" Sets the canvas border mode as sunken, none or raised; and the border\n"
136" width. These parameters are closely linked to the canvas fill color\n"
137" because of the 3D effect will be based on it.\n"
138"\n"
139"'Date' group:\n"
140" You can choose to show or hide the date in your canvases via the\n"
141" check button 'Show'.\n"
142" If 'Show' is selected, you can set the following date parameters:\n"
143" color, size, format, font, alignement and angle. The date position \n"
144" is specified in percent of the pad size.\n"
145;
146
148"Sets the style values related to the pad objcts.\n"
149"\n"
150"'Margin' group:\n"
151" Generally, when including an object in a pad, one doesn't want it to\n"
152" fill the whole pad. These margins describe the amount of empty space left\n"
153" around the objects inside a pad.\n"
154"\n"
155"'Border' group:\n"
156" Sets the pad border mode as sunken, none or raised; and the border\n"
157" width. These parameters are closely linked to the pad fill color\n"
158" because of the 3D effect will be based on it.\n"
159"\n"
160"'Fill' group: \n"
161" You can modify here the color which is used to fill the pads.\n"
162"\n"
163"'Ticks' group:\n"
164" This group allows you to show the special pad ticks along each axis.\n"
165"\n"
166"'Grid' group:\n"
167" You can choose to show or hide the grid along the two axis X and Y, by\n"
168" selecting the options. Moreover, you can change the lines settings:\n"
169" the color, the line width and line style can be modified.\n"
170;
171
172const char gHelpSMHistos[] =
173"Sets the style values related to the histogram objcts. The style values\n"
174"are grouped in three sub-tabs: Histos, Frames and Graphs.\n"
175"\n"
176"'Histos' Tab:\n"
177"\n"
178"'Fill' group: \n"
179" Sets the color and the pattern for filling histograms.\n"
180"\n"
181"'Line' group:\n"
182" Sets the line parameters for histograms: color, line width and style\n"
183"\n"
184"'Bar' group:\n"
185" Sets the width and offset of bars for graph objects.\n"
186"\n"
187"'Contours' group:\n"
188" Sets the number of contours for drawing by default.\n"
189"\n"
190"'Axis' group:\n"
191" 'Minimum zero':\n"
192" Check this option to force the minimum of axis to be zero.\n"
193" Otherwise, the minimum will be computed.\n"
194" 'Paint format':\n"
195" It is the axis printing format for the TH2 objects. This format is\n"
196" used as an argument in a C++ printf() method.\n"
197"\n"
198"'3D Cylindrical' group:\n"
199" The inner radius is useful for some 3D graphics. Using the cylindrical\n"
200" coordinates system, this value represents the percentage of the radius\n"
201" allocated to the inner radius.\n"
202"\n"
203"The 'Frames' Tab:\n"
204"'Fill' group: \n"
205" Sets the color and the pattern for frames.\n"
206"\n"
207"'Line' group:\n"
208" Sets the line parameters for frames: color, line width and style\n"
209"\n"
210"'Border' group:\n"
211" Sets the frame border mode as sunken, none or raised; and the border\n"
212" width. These parameters are closely linked to the frame fill color\n"
213" because of the 3D effect will be based on it.\n"
214"\n"
215"\n"
216"The 'Graphs' tab:\n"
217"'Line' group:\n"
218" Sets the line parameters for graphs: color, line width and style\n"
219"\n"
220"'Errors' group:\n"
221" End error size:\n"
222" Specifies the size of lines which are drawn at the end of error\n"
223" bars.\n"
224" Error along X:\n"
225" Sets percent of the bin width to be used for errors along X.\n"
226"\n"
227"'Draw Border' option:\n"
228" Specifies if the border of the filled functions must be drawn or not.\n"
229;
230
231const char gHelpSMAxis[] =
232"Sets the style values related to the axis grouped in three sub-tabs:\n"
233"X axis, Y axis and Z axis.\n"
234"\n"
235"'Decimal labels' option:\n"
236" Allows you to specify if you want to print the decimal part of the\n"
237" labels in the axis.\n"
238"\n"
239"'Date/Time offset' group:\n"
240" Sets the time offset shown in two parts: as a date and time.\n"
241"\n"
242"'Line' group:\n"
243" Sets the color, the ticks' length and logarithmic scale.\n"
244"\n"
245"'Title' group:\n"
246" Sets the appearance of the axis title: color, font, font size and offset.\n"
247"\n"
248"'Divisions' group:\n"
249" * Sets the tertiary, the secondary and the primary axis division numbers.\n"
250" * with the 'Optimize' option ON or OFF\n"
251"\n"
252"'Labels' group:\n"
253" Sets the axis labels' appearance. Similar as the title group.\n"
254;
255
256const char gHelpSMTitle[] =
257"In this tad, the information related with titles are edited. You can choose\n"
258"to show or hide the title in your canvases via the check button 'Show title'.\n"
259"\n"
260"'Fill' group: \n"
261" You can modify here the color and the pattern which is used to fill\n"
262" the title pave.\n"
263"\n"
264"'Text' group:\n"
265" The various parameters in the text group are the color, the font, the\n"
266" alignement and the font size. The font size can be specified in pixels or\n"
267" in percentage of the pad.\n"
268"\n"
270" Shadows are little borders added behind the object to create an\n"
271" illusion of third dimension. The size of the shadow depend on the\n"
272" importance of each object.\n"
273"\n"
274"'Geometry' group:\n"
275" What can be changed here is the geometry of the title pave. By setting\n"
276" these values, you define the size and the location where the title pave\n"
277" will be placed. The fields are the abscissa (X), the ordinate (Y),\n"
278" the width (W) and the height (H).\n"
279;
280
281const char gHelpSMStats[] =
282"In this tad, the information related with stats are edited.\n"
283"\n"
284"'Fill' group: \n"
285" You can modify here the color and the pattern which is used to fill\n"
286" the statistics pave.\n"
287"\n"
289" Shadows are little borders added behind the object to create an\n"
290" illusion of third dimension. The size of the shadow depend on the\n"
291" importance of the object.\n"
292"\n"
293"'Text' group:\n"
294" The various parameters in the text group are the color, the font and\n"
295" the font size. The font size can be specified in pixels or in percentage\n"
297"\n"
298"'Geometry' group:\n"
299" What can be changed here is the geometry of the stats pave. By setting\n"
300" these values, you define the size and the location where the stats pave\n"
301" will be placed. The fields are the abscissa (X), the ordinate (Y),\n"
302" the width (W) and the height (H).\n"
303"\n"
304"'Stat Options' group:\n"
305" You can select the information you want to see in the stats pave.\n"
306" The paint format is used as an argument in a C++ printf() method: it\n"
307" describes how the value will be shown.\n"
308"\n"
309"'Fit Options' group:\n"
310" You can select the way you want to show information in the pave.\n"
311" The paint format is used as an argument in a C++ printf() method: it\n"
312" describes how the value will be shown.\n"
313;
314
315const char gHelpSMPSPDF[] =
316"In this tad, the information related with PS and PDF are edited. These\n"
317"settings can't be previewed, but as in the other tabs, any modification in\n"
318"this one will take effect.\n"
319"\n"
321" Define a string to be inserted in the Postscript header. The string in\n"
322" header will be added to the Postscript file immediatly following the\n"
323" %%Page line.\n"
324" For example, this string may contain special Postscript instructions\n"
325" like: '200 200 translate'\n"
326" The following header string will print the string \"my annotation\" at\n"
327" the bottom left corner of the page (outside the user area):\n"
328" 'gsave 100 -100 t 0 r 0 0 m /Helvetica-Bold findfont 56 sf 0 0 m ( my\n"
329" annotation ) show gr'\n"
330"\n"
331"'Title' group:\n"
332" Define a string to be used in the %%Title of the Postscript files.\n"
333" If this string is not defined, ROOT will use the canvas title.\n"
334"\n"
335"'Paper Size' group:\n"
336" Set paper size for PostScript output. You can choose a predefined size\n"
337" or specify manually the width and the height of the printed area.\n"
338"\n"
339"'Line scale' option:\n"
340" To specify a line scale factor when drawing lines on Postscript.\n"
341"\n"
342"'Color Model' group:\n"
343" Define the color model used by TPostScript and TPDF (RGB or CMYK).\n"
344" CMYK model is a subtractive color model unlike RGB which is an additive.\n"
345" They are mainly used for printing purposes. CMYK means Cyan Magenta\n"
346" Yellow Black, RGB means Red Green Blue.\n"
347;
const char gHelpSMPSPDF[]
Definition: HelpSMText.cxx:315
const char gHelpSMAxis[]
Definition: HelpSMText.cxx:231
const char gHelpSMGeneral[]
Definition: HelpSMText.cxx:101
const char gHelpSMCanvas[]
Definition: HelpSMText.cxx:124
const char gHelpSMTopLevel[]
Definition: HelpSMText.cxx:14
const char gHelpSMHistos[]
Definition: HelpSMText.cxx:172
const char gHelpSMTitle[]
Definition: HelpSMText.cxx:256
const char gHelpSMStats[]
Definition: HelpSMText.cxx:281