From 28cb8583c3061390f965999c08c1f1ebce266bd1 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Fri, 15 Oct 2010 12:10:59 -0400 Subject: [PATCH] docs: move some tutorial content to the reference We add a "Getting started" chapter that will grow into a (hopefully) non-outdated, maintained tutorial. For now, it includes two minimal examples by xincluding them. --- docs/reference/gtk/Makefile.am | 7 +- docs/reference/gtk/getting_started.xml | 16 ++- docs/reference/gtk/gtk-docs.sgml | 99 +------------------ docs/reference/gtk/images/hello-world.png | Bin 0 -> 3736 bytes docs/reference/gtk/images/window-default.png | Bin 0 -> 4845 bytes 5 files changed, 21 insertions(+), 101 deletions(-) create mode 100644 docs/reference/gtk/images/hello-world.png create mode 100644 docs/reference/gtk/images/window-default.png diff --git a/docs/reference/gtk/Makefile.am b/docs/reference/gtk/Makefile.am index 0140db6cb3..162eb2e50e 100644 --- a/docs/reference/gtk/Makefile.am +++ b/docs/reference/gtk/Makefile.am @@ -133,7 +133,8 @@ content_files = \ gtk-update-icon-cache-3.0.xml \ gtk-builder-convert-3.0.xml \ visual_index.xml \ - getting_started.xml + getting_started.xml \ + overview.xml expand_content_files = \ drawing-model.xml \ @@ -317,7 +318,9 @@ HTML_IMAGES = \ $(srcdir)/images/layout-rlbt.png \ $(srcdir)/images/layout-rltb.png \ $(srcdir)/images/layout-tblr.png \ - $(srcdir)/images/layout-tbrl.png + $(srcdir)/images/layout-tbrl.png \ + $(srcdir)/images/window-default.png \ + $(srcdir)/images/hello-world.png # Extra options to supply to gtkdoc-fixref FIXXREF_OPTIONS=--extra-dir=../gdk/html \ diff --git a/docs/reference/gtk/getting_started.xml b/docs/reference/gtk/getting_started.xml index 8ce21b900b..ddbff64f8f 100644 --- a/docs/reference/gtk/getting_started.xml +++ b/docs/reference/gtk/getting_started.xml @@ -5,8 +5,16 @@ Getting Started with GTK+ + This chapter is contains some tutorial information to get you + started with GTK+ programming. It assumes that you have GTK+, its + dependencies and a C compiler installed and ready to use. If you + need to build GTK+ itself first, refer to the + Compiling the GTK+ libraries + section in this reference. + To begin our introduction to GTK, we'll start with the simplest - program possible. This program will create a 200x200 pixel window: + program possible. This program will create an empty 200x200 pixel + window: @@ -84,10 +92,14 @@ In the long tradition of programming languages and libraries, it is called Hello, World. + + + + Hello World in GTK+ - + FIXME: MISSING XINCLUDE CONTENT diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml index d089e86413..7faf5122c6 100644 --- a/docs/reference/gtk/gtk-docs.sgml +++ b/docs/reference/gtk/gtk-docs.sgml @@ -16,106 +16,11 @@ GTK+ Overview - - -GTK+ is a library for creating graphical user interfaces. It -works on many UNIX-like platforms, Windows, and OS X. -GTK+ is released under the GNU Library General Public License -(GNU LGPL), which allows for flexible licensing of client -applications. GTK+ has a C-based object-oriented architecture that -allows for maximum flexibility. Bindings for many other languages have -been written, including C++, Objective-C, Guile/Scheme, Perl, Python, -TOM, Ada95, Free Pascal, and Eiffel. - - -GTK+ depends on the following libraries: - - - -GLib - -A general-purpose utility library, not specific to graphical user interfaces. -GLib provides many useful data types, macros, type conversions, -string utilities, file utilities, a main loop abstraction, and so on. - - - - -GObject -A library that provides a type system, a collection of -fundamental types including an object type, a signal system. - - - - -GIO -A modern, easy-to-use VFS API including abstractions for -files, drives, volumes, stream IO, as well as network programming and -DBus communication. - - - - -cairo -Cairo is a 2D graphics library with support for multiple -output devices. - - - - -Pango - -Pango is a library for internationalized text handling. It centers -around the PangoLayout object, representing a paragraph of text. -Pango provides the engine for GtkTextView, GtkLabel, GtkEntry, and -other widgets that display text. - - - - -ATK - -ATK is the Accessibility Toolkit. It provides a set of generic -interfaces allowing accessibility technologies to interact with a -graphical user interface. For example, a screen reader uses ATK to -discover the text in an interface and read it to blind users. GTK+ -widgets have built-in support for accessibility using the ATK -framework. - - - - -GdkPixbuf - -This is a small library which allows you to create GdkPixbuf -("pixel buffer") objects from image data or image files. -Use a GdkPixbuf in combination with GtkImage to display images. - - - - -GDK - -GDK is the abstraction layer that allows GTK+ to support multiple -windowing systems. GDK provides window system facilities on X11, Windows, -and OS X. - - - - -GTK+ - -The GTK+ library itself contains widgets, -that is, GUI components such as GtkButton or GtkTextView. - - - - - + + - diff --git a/docs/reference/gtk/images/hello-world.png b/docs/reference/gtk/images/hello-world.png new file mode 100644 index 0000000000000000000000000000000000000000..acf7aaff8f4f14a0e1aaa1f0b90ac2a2496db8d3 GIT binary patch literal 3736 zcmZ`+c{CK>`yQnbN|a=mEnAX(FFP5NHH@VgV_%BwJCP8gY%z#YWXWzUV`nT44aV3e zdyKJWEMxi2=il!+zkAMm-}Bu2p8K5pzR!8@xe3pVbQ!O)UjqODjQV<7CKT^WF(B<# z%KS+htW0s#z8d;ww3HD_3wcMucm1?2{Y<@~egQ9EI{}=%ygi*Hd>vmqIeGcIc>8T% zMyde-*G2WUo|pxGA$|!8Wx+=EBl%H(z?P9zi9>8WO{?!ZkA#>sIDEPo=>#DdKXtm2 zLR6^$5vtkZn!Xx4%2}6N46N~-4b7=uo{rsQ?pnC~t~sSgVRnkMQ|_pzW;uu)4{?R) ze->Aa>vdanN_46LpVH5A1Qk`rM%Z_MHwdZbkamk6;Ue&y7v7NhLs%Sd~$EVU=2| z?#6>=ewqO)CSu%1$4iL$n{@lPHezlYIo~V17YQ}M@D-gy)@N;qBirXZA!@E!!~uI5yR#{-m1z%!rU^X=lj-jBEDC+yyBl zgo8xGe$O@ij9~1*Xq+)qH=TkkT^BXZT5pbQruQP46cX?kt)^`?ZSht?AXa@%a?Qox zE9Xb&+`s#i76-=ChqGKDIwVLAcvw7Wk6&ob(5JjGjZ@kehfe=G?p9T$JO`5hbX08m zP`2?Yf;i2mB;hK;pTIGCBeM2RnW9;E#zKt4k@2~LkxkR0@$-Z^L)=hcbH%@E5RHt; z8jan7($>v}e_O8yGr%gVixvDvY3jXO*6^Q@F+;O^2A$@aZ3hEak=n||*{OXx(u z*M4K8HTE;E+3WW}Amvg&9bT!09W1B>9}1-M3W+A=AfS}hG?_>3rnZ7=$=Lw*wCR?cy2;8I)2+LCOhe>|tZlVCroY_+ulpHZjkV@D!asgL&Nf;AYAdV4 z58)g$=t!pMiMQJSo$lb#$dSojS&i`F=#INC*Z?b}5co@jM?AM~jFUug2xHV_kD$Ir zO}!Q&z*$;#or;!+Cz6)8^KTQ6shenj0sONCo?4ZcQl^<)FK4GWvulZ!D32$+8KuAc z>z`%~vo@}Xy!jMJgmOXMIN`WH!;((YgQ>*)q6WaGdTXw;NZO ze&z64>t@aifvY~$%#oEvFi-l9ega%%Ef|w^x;#R9R*jw~v^0GnhfY+q`DJhaf~}?X zroT(Lwq(+Mn~8~q3(BME#P_i0-|n~aV*0rseNfK2{iwF@NBi zVs3Y7db@&CQSioGA*j{}d_vk66G2FT5JW%!PCxU;J;U26bILe1oRxVKBOOXDuF~=g zTH4#YFvV`0qF^*sbWD$30Q@v#T3F{}Uvuf-#p0fv`8RI%7?+piLW3I2)c`hWuJuc> zH$`kSDy94Wg?{E(NW(L{$JHO{dEsX?m!^cZ$8Hufa7~p`GH&M$oW83jP`FRc_4jv0 zf<#-3I6upx6}gk!2v(&@tNVOqJ$w|CWSY=Ie$tLsXED)`{R^)@y3 zYW9QpMmg!wXAD;IB|d+aol+16p>Emeww*fc<#j#hU{nH~%C3b7aAZVFTl-@cQwmcw zU!TI{9oS<1jl+Tox4X(pwvcc*(9s9#? z4}a~Qg{q(D!^?ZtD6wCEHox5&wfnE10y!p4*W>%f*L|hxtz9f;hYnaCSulC?pIPwXwcY1iaV5Ru2J4mGKgglN z^iYVelo`mQIKux#6*?(1DI4`VaMkT-DgHxa=W~PBOk*N>V_jylVOicdEAF{t8CaKtq&h?F- zIU$3c?GI@N8TS<=h2>Mq1`Uj0N=_+a5+e70xfB=o{4A)bs7TIJ_D{{s#IHQE245z_ zTnhYRvM=#LN=JgTn-d%DB8V?*n?K>t`VCB&<5}F_Ic$tHXM7_173=cG?yz~exxF~9 zp<#n^b`(spvEpT6zRu+~gSRz=JpZ{A6%~ny%tQaQaNtH*Swe)kL&B*+Zb}U*|2;bkPyO(M|Fe;_m!0FsKY|3FEzel$mnRX zT0mF@G~uv(XG<3(_xFhnyN6v7CJl$YR|19|I=^I(kB=)=R0sSvkB!*fciNn7j(Niq zIt(At9>-#9T^3XzR!tcdV=k!SL3nX78(%?5Z%@8zi&Y>tg^rPaDYpu#LwjFDMCg|b zWU4x_>V)=ah)}hg7$1&84erk({j%M;cx?I-So)8VKyc97++pBKiELd%jtZ<1a5Rs= z1zhZ2kNf+ult`4naKPK!+xLUL+dEI@UPU4$ACJO}l9b z*xl1I*(6x%lfiFh=cm*5IAjD*%V7KKTw!@h7*Vhnu!(C+T@!j+kwdG^;2m#N3Y$g$@eWoDw_+E$gY1F^8ZKq2Dku&f+ z)g^(Y7&%`OXGs3u-s@qg^xbvGFAVq=XZbaB-oDcDF=^%+#7fA~0j}zmI`(c%A!~2X zdv;PpSw6+F|HJErt}6yl-=hY9Jpp9n6f-`v@<$R&1ecdr$Uk6N8Jj;p+`g^Lq>-w| z*Uc?Yg8S83SIqd{xle_6&KZGz{>-F* z($Z3}9|H)P($|PP{>&n}etKDpQ^L8(=BD04a?r(^atnSnF{PuYcO*G^6}l| zqt+GsFn!3Q9?anDUXFRCxWX9el?@2mdZ>c;TqplM&V-$2d`eLrj6$f|LS{4%Q1ITPX!#2Q7j>mmqc=qfGP1I1Qc@U^a0d%kAP@+FI+1@!#`=hqJ95Fm zZC9gSbT!F%Wyg_A=c}N&hQ)5PMCUr zWUvTxi281$dManyg)ppcFO0I|+i<9S>?)f(W^5ts__HFN}D5hvBea+Ez#7q4##<*UGg~z>j+wUu*x}t3y zy3V}w!eM9UY0Sw|!K}BItDVSHa+@k#JA`^~t-6m|Hb`1l*5#s<_b(pTT>vrO(z47+ ze@g{L&CtZgRqDF=eVx)wR);RZt6Jm>EH$ly`nhISHcBt&ppOinou@DOd6)O}p5I^B#^2J%)j!DD56s}^?c)WOfr9+NU~j0q zk3WgIU5kO?YJ}nAhtGm@w`N0pbA!VAb`I;BQ?2@*OoIoSIEQLiu!+!_8pGw_R4zXq zP5!hS9wm3UR>$sNNK2gna%qRNS_qvXxX9`Sn3y>v~?%1sd$YWN;%`e?{LrG4&n z72y@+su~fzkkH=#Jnq-EI2OR>rxAhh{dvjG8_~>7v~f9Xe)wJzgZmbLut=sPS@*Dq z@g#CF*L%ZH&A`ks3jq~rf{0aL=@3rnX94Xf1UY0+e(Yz{r#}mob@;SCcB(qx_NvS3 z?L$~+ua*cQaPKlx^-gBX>0TwNCD^#)Q=goKmfh30GKSV{D(=8Caa&{9;?x zw!@*7pI-#l<;J_V>q{xfqZL`09-2<&mXtU1Mu=(~e~3paJCN0FL9kIUhtQG4i~4z; zK)Z=tSHUW;BFeUu=gh8it)A;IR3pPT2U<%jsSiZdw%mdThLM2;|2}mQn6D`cX}t16 zKllKOwaLoq=XBEQEse3dNaP!buq`aHMTGO_McK4bCz^91|A?K1CAwEaE}nZQsBSyl zg_3jYsuf(u+3#@%hu}%!BPM`hu`>9^d1TcK!0EhzYQTu8(M_&g?D$}(0_T)iogS+3 zSV{TmV{OZYpEQx?FsmTSGP#}dQJ7Op&eYsE=Dw_?RHp1LNh#(x znFq3_R_LeSZ)aeYsy z@$!4H-Wp|yg`-^uYrQet>!)tdMO4z2>O=~%f6Na%*B2y(0gUNnH8 zyUUbpGzSwFIIr^Z4i!Vt=FrN#%D;{=t&X06<>glcBgQ3P?I?5@lfi;jI z@KGbs+Io~%q%k{PTzMgM$%F?XlkMkS=)t+96=Inzr_mC#4ggi_v100l>~g`*&e5kg z#DECyjGAgP!g2)Sy;Yzv*@HL>Rv-RI+dSzFhid_W@O5vE3pE>nQa zOxUy)ZVnPE=W!dy1Vxk1mfe4cdOjjv(Kmbc`mngi)3z>g4KeLtIa$;uBl0jKHM4J)t{#d_Chrr7o13M~$JoCJ4!88L+*g_>83Dx!x^1V^o zR9FMZ0gj8-QK%2_JAj8B)m8z|lzv2N|32GkU0}{06^fv(5qf(X4E&qvhVzn`IJ`OQ zaA9V1t|odf{alkA$Jp4kzTw($sMv5YC%#(nWn?rO!5_q~}DHg7vUs2fld!8$Ooy}hal z3GqZbCg!d#$%$aPCps^As{1$h1$lN~zdu^PG*c=d+#Df zd&mqoKx)x@*{@lyC@Cqq#Cfjs5M=v_xUo7Q(6+aId9rfts8s%BV7?sl{ce8b4G~hF z#}{c}0t}U&_A#^H`fP(s#({=+lSoVD>szeO&#Vl$YnBDEd1YRA^#%729cMaTU4CU_ zkvh=lUCOZ7QChr8yapTOZCTYE!y`tc!B=WZvO@p<$Eu+Zuqh~~fvt%$ClMcy`O%#E zQC%r5FSP?FvcSYs7`nXHrqWS4pCN5)51(pGarNgox9A&naPQ@n+2C(uNtw*CicQTQ z=FZ>BM{tpfi#8t6m>ua*rt=o2rE;@%bR;Jg>GGd!D!bX_B3QMbJGec|5}W)IUJlv9 z#rbUYtyIs@tPhv`)V|&x!NZ|)M(jF$4GW<=TvSeUU7H3{F8tLdlBcVytMHauV%Wtf;!8_pD+_Y-?fn z3s1WY&W^N&@M!jLVbV{`ma%4Y1N&0D{eOZ|Nv-hQ0xu{vpeWa4lTg*}WN788hOTh< zIe8YE+&08qDBctoAF!K}0G)8;fsrLdeas5BPqC&)kXyaJ3ozhsAWh=Q~0-pj&N{ESZfhZ6$OTO&cTAchJmfRwMfR8MO-Yt#`QJRUs zd#~kOuF)bsXp}TOz<;bR##Bp7X~3Eqt(&WMB9H@f&iNt$bw8+32(6m$;8?P?y}vP~ zSThR1-hZEGuwT{O<=IkKvj>4OSR*dC41nQdpETU>hSt|0CwbKx!C_ZW6>>}k^`)^{ zGb-@5)zPoLqr!p*INzvgWy+xQm9QD&VN!TT*T10w*`C=CvBE)+_X!EvJ2^t8=&0

Xy$|PM$CRWqp#W{c|i{Lg?=>T782l5 zJJfsTRSboNQdiv}II?gTPq|2TGF#|APW$7rSGDiO+Xb}dcJpg0 z&U{rF>zY?md9=#C9YSHYWpTU2RJCnMg z*Oqa%_I8iMUJ!px|K_$!1OMEa4K$q&Sn^fbrqbrBH4u4HjP^L4A6~3%vA3PlFGU>) zpY4*xx_f)80}c0xt{f$4bZ7c&!^>`YErjN-xPc%%Zv7`#&vZxD{_(baD9RI0`GWm^ z{k4I@)SQKNynj6uDS!;wT|##H@WH`{jM5d`s^cR<$YZKVTkqTS^gBeooY&eZf|<+^ zmn2X^TjNXB&xh}=vw1~G1kWwqn3mJ+7|Z!FT}wA0vyRr)x%&*yrUFvZv+ms}7;rTU zwAIlEDqfzaJ5L??CqTu1aYSXyPw5EVONholR%XGlSE?yb zeD?t*-5r!`rCjfAq-d}Q!8H{3=PP7~I_tegln#=UleJBBlpzQg5LT&VL;VimF#O~> z2|7pOU-LNWg8J;1Qm1Rm6ymSSYqL7q^vco(VMTUXzg_Dg-D`#} zP7XXV!f%YW59fz(&VFrm#^bWq$vLHe?!+r#h>D;Ez9ZVOL+d{*PV+Q1dh}FPRV^%x za*XoC64pdoo{WEfR_WB7j^m{i=K=zbSA&)WW+jDhF*YE>)wbSc{WAa4I_XH*Kk14>b%8 z#l;&uyf!+Pe5+ljcDL2m*8z=w;5RcfHhw%{i-obr_xK8{MU(cvugWsD0_~F}m32FW^Bt#XzvSQrepr@zCFLpz3%bb{6=u8__4b>m5vNzInIN3vIkdB4kpG2U3 zPhOv8Zr%G87~0hQhqV9x7hu>V;e?*oK_}>3T^Ani