diff options
Diffstat (limited to 'doc/en/PerlQt.pod')
| -rw-r--r-- | doc/en/PerlQt.pod | 386 |
1 files changed, 193 insertions, 193 deletions
diff --git a/doc/en/PerlQt.pod b/doc/en/PerlQt.pod index b05a0a9..5593aa9 100644 --- a/doc/en/PerlQt.pod +++ b/doc/en/PerlQt.pod @@ -1,39 +1,39 @@ -=head1 Programming PerlQt +=head1 Programming PerlTQt B<Germain Garand> -This document describes a set of Perl bindings for the Qt toolkit. Contact +This document describes a set of Perl bindings for the TQt toolkit. Contact the author at <germain@ebooksfrance.com> =head1 Introduction -PerlQt-3 is Ashley Winters' full featured object oriented interface to -L<Trolltech|"http://www.trolltech.com">'s C++ Qt toolkit v3.0. +PerlTQt-3 is Ashley Winters' full featured object oriented interface to +L<Trolltech|"http://www.trolltech.com">'s C++ TQt toolkit v3.0. It is based on the L<SMOKE|"http://webcvs.kde.org/cgi-bin/cvsweb.cgi/kdebindings/smoke"> -library, a language independent low-level wrapper generated from Qt headers by +library, a language independent low-level wrapper generated from TQt headers by Richard Dale's L<kalyptus|"http://webcvs.kde.org/cgi-bin/cvsweb.cgi/kdebindings/kalyptus"> thanks to David Faure's module. -This document describes the principles of PerlQt programming. +This document describes the principles of PerlTQt programming. It assumes you have some basic Perl Object Oriented programming knowledge. Some C++ knowledge is recommended but not required. -It would mostly help you to find your way through L<Qt's +It would mostly help you to find your way through L<TQt's excellent documentation|"http://doc.trolltech.com"> which is our ultimate and only reference. -If Qt is installed on your system, then you most probably -also have its documentation. Try the C<$QTDIR/bin/assistant> program. +If TQt is installed on your system, then you most probably +also have its documentation. Try the C<$TQTDIR/bin/assistant> program. =head1 Installation =head2 Requirements -To compile and use PerlQt, you'll need : +To compile and use PerlTQt, you'll need : =over 4 @@ -51,25 +51,25 @@ L<Perl E<gt>= v5.6.0|"http://www.perl.org"> =item * -L<Qt E<gt>= +L<TQt E<gt>= v3.0|"http://www.trolltech.com/developer/download/qt-x11.html"> =item * -L<SmokeQt 1.2.1|"http://webcvs.kde.org/cgi-bin/cvsweb.cgi/kdebindings/smoke"> +L<SmokeTQt 1.2.1|"http://webcvs.kde.org/cgi-bin/cvsweb.cgi/kdebindings/smoke"> The SMOKE library (Scripting Meta Object Kompiler) is part of L<KDE|"http://www.kde.org">'s B<kdebindings> module. You may want to check if a precompiled version of this module exists for your system. -PerlQt is packaged with its own copy, so you don't need to check it out. +PerlTQt is packaged with its own copy, so you don't need to check it out. =back -Perl and Qt's installation is out of the scope of this document. Please refer +Perl and TQt's installation is out of the scope of this document. Please refer to those projects' documentation. =head2 Compilation -PerlQt uses GNU's Autoconf framework. However, the standard ./configure script is preferably driven +PerlTQt uses GNU's Autoconf framework. However, the standard ./configure script is preferably driven by the Makefile.PL wrapper. All options are forwarded to ./configure : perl Makefile.PL @@ -81,7 +81,7 @@ Then : make install -This will install PerlQt, Puic and Smoke (if needed), as well as the pqtsh and pqtapi utilities. +This will install PerlTQt, Puic and Smoke (if needed), as well as the pqtsh and pqtapi utilities. The preferred install location for SMOKE and Puic is in the KDE3 file system. If you don't have KDE3 installed, specify a location with C<configure>'s @@ -91,13 +91,13 @@ C<--prefix> option. e.g: =head2 Troubleshooting and Configure Options -If Smoke's linking fails or your Qt library was built with very specific +If Smoke's linking fails or your TQt library was built with very specific options, run Makefile.PL again with: perl Makefile.PL --with-threshold=0 When building smoke, configure will check for OpenGL and try to compile -support for it if it is properly installed and supported by Qt. +support for it if it is properly installed and supported by TQt. You may disable this checking with: @@ -110,9 +110,9 @@ it, specify: --without-Mesa -=head2 How to install PerlQt with user rights +=head2 How to install PerlTQt with user rights -To install PerlQt without super-user rights, simply follow this procedure: +To install PerlTQt without super-user rights, simply follow this procedure: =over 4 @@ -128,11 +128,11 @@ The above would install the Smoke library in ~/lib and the puic binary in ~/bin Reconfigure the Perl module so that it doesn't target the standard perl hierarchy: - cd PerlQt + cd PerlTQt perl Makefile.PL PREFIX=~ cd .. -Beware : this is not the same Makefile.PL as above, but the one located in the ./PerlQt +Beware : this is not the same Makefile.PL as above, but the one located in the ./PerlTQt subdirectory =item * @@ -154,9 +154,9 @@ or at the top of your program: =back -=head1 Anatomy of PerlQt +=head1 Anatomy of PerlTQt -A typical Qt program using GUI components is based on an event loop. +A typical TQt program using GUI components is based on an event loop. This basically means that such a program is no more envisioned as a straight flow where you would need to handle yourself every single events (such as a @@ -168,15 +168,15 @@ define what objects methods need to be called when an event occurs, and then start the main event loop. That's all! -Qt will handle all events and dispatch them to the correct subroutine. +TQt will handle all events and dispatch them to the correct subroutine. -Lets see how this process is implemented in a minimal PerlQt program. +Lets see how this process is implemented in a minimal PerlTQt program. =head2 Hello World - 1: use Qt; - 2: my $a = Qt::Application(\@ARGV); - 3: my $hello = Qt::PushButton("Hello World!", undef); + 1: use TQt; + 2: my $a = TQt::Application(\@ARGV); + 3: my $hello = TQt::PushButton("Hello World!", undef); 4: $hello->resize(160, 25); 5: $a->setMainWidget($hello); 6: $hello->show; @@ -186,16 +186,16 @@ Lets see how this process is implemented in a minimal PerlQt program. <br/> <div class='image'><img src="../images/ex1.png"/></div> -This program first loads the Qt interface [line 1] and creates the application +This program first loads the TQt interface [line 1] and creates the application object, passing it a reference to the command line arguments array C<@ARGV> [l.2]. This application object is unique, and may later be accessed from -anywhere through the B<Qt::app()> pointer. +anywhere through the B<TQt::app()> pointer. At line 3, we create a PushButton, which has no parent (i.e : it won't be contained nor owned by another widget). Therefore, we pass to the constructor an B<undef> value for the parent argument, -which is PerlQt's way of passing a Null pointer. +which is PerlTQt's way of passing a Null pointer. After some layouting at [l.4], we tell the application object that our main widget is this PushButton [l.5]... that way, it will know that closing the @@ -211,51 +211,51 @@ B<Syntax elements summary :> =item 1 -All Qt classes are accessed through the prefix B<Qt::>, which replaces the -initial B<Q> of Qt classes. -When browsing the L<Qt +All TQt classes are accessed through the prefix B<TQt::>, which replaces the +initial B<Q> of TQt classes. +When browsing the L<TQt documentation|"http://doc.trolltech.com>, you simply need to change the -name of classes so that B<QFoo> reads B<Qt::Foo>. +name of classes so that B<TQFoo> reads B<TQt::Foo>. =item 2 An object is created by calling the B<constructor> of the class. It has the same name as the class itself. -You don't need to say C<new Qt::Foo> or C<Qt::Foo-E<gt>new()> as most Perl +You don't need to say C<new TQt::Foo> or C<TQt::Foo-E<gt>new()> as most Perl programmers would have expected. Instead, you just say : - my $object = Qt::<classname>(arg_1, ..., arg_n); + my $object = TQt::<classname>(arg_1, ..., arg_n); If you don't need to pass any argument to the constructor, simply say : - my $object = Qt::<classname>; + my $object = TQt::<classname>; =item 3 Whenever you need to pass a Null pointer as an argument, use Perl's B<undef> keyword. Do not pass zero. - Beware: this is by far the most common error in PerlQt programs. + Beware: this is by far the most common error in PerlTQt programs. Pointers are arguments preceded by an B<*> -character in Qt's documentation (e.g: "C<QWidget * widget>"). +character in TQt's documentation (e.g: "C<TQWidget * widget>"). =back =head2 Inheritance and Objects -Before we can discuss how Perl subroutines can be called back from Qt, we need -to introduce PerlQt's inheritance mechanism. +Before we can discuss how Perl subroutines can be called back from TQt, we need +to introduce PerlTQt's inheritance mechanism. -PerlQt was designed to couple as tightly as possible Qt's simplicity and Perl's +PerlTQt was designed to couple as tightly as possible TQt's simplicity and Perl's power and flexibility. In order to achieve that goal, the classical Object Oriented Perl paradigm had -to be extended, much in the same way than Qt itself +to be extended, much in the same way than TQt itself had to extend C++'s paradigm with B<metaobjects>. =head3 A Custom Widget @@ -266,8 +266,8 @@ of PushButton: 1: use strict; 2: 3: package Button; - 4: use Qt; - 5: use Qt::isa qw(Qt::PushButton); + 4: use TQt; + 5: use TQt::isa qw(TQt::PushButton); 6: 7: sub NEW 8: { @@ -279,29 +279,29 @@ of PushButton: 14: 15: package main; 16: - 17: use Qt; + 17: use TQt; 18: use Button; 19: - 20: my $a = Qt::Application(\@ARGV); + 20: my $a = TQt::Application(\@ARGV); 21: my $w = Button("Hello World!", undef); 22: $a->setMainWidget($w); 23: $w->show; 24: exit $a->exec; Here, we want to create our own version of the PushButton widget. -Therefore, we create a new package for it [l.3] and import Qt [l.4]. +Therefore, we create a new package for it [l.3] and import TQt [l.4]. We now want to declare our widget as subclassing PushButton. -This is done through the use of the C<Qt::isa> pragma [l.5], which accepts a -list of one or more parent Qt classes. +This is done through the use of the C<TQt::isa> pragma [l.5], which accepts a +list of one or more parent TQt classes. It is now time to create a B<constructor> for our new widget. This is done by creating a subroutine called B<NEW> I<(note the capitalized -form, which differentate it from the usual "new" constructor. PerlQt's NEW +form, which differentate it from the usual "new" constructor. PerlTQt's NEW constructor is called >B<implicitly>I< as can be seen on line 21)>. Since we want our widget to call its parent's constructor first, we call the -B<superclass's constructor> (here: Qt::PushButton) on line 9, passing it all +B<superclass's constructor> (here: TQt::PushButton) on line 9, passing it all arguments we received. At this time, a class instance has been created and stored into a special @@ -316,7 +316,7 @@ When building a new composite widget, you may just create its different parts inside B<my> variables, since widgets are only deleted by their parents and not necessarily when their container goes out of scope. -In other words, PerlQt performs clever reference counting to prevent +In other words, PerlTQt performs clever reference counting to prevent indesirable deletion of objects. Now, you'll often want to keep an access to those parts from anywhere inside @@ -328,15 +328,15 @@ checking... Here come B<Attributes>. Attributes are data holders where you can store any kind of properties for your object. -Declaring new attributes is done through the C<use Qt::attributes> pragma, as is +Declaring new attributes is done through the C<use TQt::attributes> pragma, as is demonstrated in the following package implementation : 1: use strict; 2: 3: package Button; - 4: use Qt; - 5: use Qt::isa qw(Qt::PushButton); - 6: use Qt::attributes qw( + 4: use TQt; + 5: use TQt::isa qw(TQt::PushButton); + 6: use TQt::attributes qw( 7: itsTime 8: pData 9: ); @@ -344,7 +344,7 @@ demonstrated in the following package implementation : 11: sub NEW 12: { 13: shift->SUPER::NEW(@_[0..2]); - 14: itsTime = Qt::Time; + 14: itsTime = TQt::Time; 15: itsTime->start; 16: pData = " Foo "; 17: } @@ -362,7 +362,7 @@ demonstrated in the following package implementation : <div class='image'><img src="../images/ex2.png"/></div> -An attribute itsTime is declared at line 7, and loaded with a C<Qt::Time> object +An attribute itsTime is declared at line 7, and loaded with a C<TQt::Time> object at line 14. Since we reimplement the virtual function "resizeEvent" [l.19]. @@ -376,11 +376,11 @@ B<Recapitulation> =item * -In order to inherit a Qt class, a package must contain a -C<use Qt::isa> pragma. +In order to inherit a TQt class, a package must contain a +C<use TQt::isa> pragma. e.g: - use Qt::isa "Qt::widget"; + use TQt::isa "TQt::widget"; =item * @@ -441,7 +441,7 @@ construct is also available, but will pass the object as first argument. Whenever you need to store a contained object in your package, you may define it as an B<Attribute> : - use Qt::attributes qw( + use TQt::attributes qw( firstAttribute ... lastAttribute); @@ -456,21 +456,21 @@ and then use it as a convenient accessor : To reimplement a B<virtual function>, simply create a B<sub> with the same name in your object. -Existing virtual functions are marked as such in Qt's documentation +Existing virtual functions are marked as such in TQt's documentation (they are prefixed with the "virtual" keyword). -You can inspect what virtual function names are being called by Qt at runtime by -putting a C<use Qt::debug qw( virtual )> statement at the top of your program. +You can inspect what virtual function names are being called by TQt at runtime by +putting a C<use TQt::debug qw( virtual )> statement at the top of your program. =back =head2 Signals and Slots -We'll now learn how Qt objects can communicate with each other, +We'll now learn how TQt objects can communicate with each other, allowing an event occuring, for instance, in a given widget to trigger the execution of one or several subroutines anywhere inside your program. -Most other toolkits use callbacks for that purpose, but Qt has a much more +Most other toolkits use callbacks for that purpose, but TQt has a much more powerful and flexible mechanism called B<Signals and Slots>. Signals and slots are used for communication between objects. @@ -482,23 +482,23 @@ recorder deck can start to record when it receives a signal wired to it's input slot, and it doesn't need to know that this signal is also received by a CD recorder device, or listened through headphones. -A Qt component behaves just like that. It has several output B<Signals> and +A TQt component behaves just like that. It has several output B<Signals> and several input B<Slots> - and each signal can be connected to an unlimited number of listening slots of the same type, wether they are inside or outside the component. The general syntax of this connection process is either : -Qt::Object::connect( sender, SIGNAL 'mysignal(arg_type)', -receiver, SLOT 'myslot(arg_type)'); +TQt::Object::connect( sender, TQT_SIGNAL 'mysignal(arg_type)', +receiver, TQT_SLOT 'myslot(arg_type)'); or -myObject->connect( sender, SIGNAL 'mysignal(arg_type)', SLOT +myObject->connect( sender, TQT_SIGNAL 'mysignal(arg_type)', TQT_SLOT 'myslot(arg_type)'); This mechanism can be extended at will by the declaration of custom Signals and -Slots, through the C<use Qt::signals> and C<use Qt::slots> pragma +Slots, through the C<use TQt::signals> and C<use TQt::slots> pragma (see also the other syntax, later on). Each declared slot will call the corresponding subroutine in your object, @@ -509,22 +509,22 @@ B<As an example, lets rewrite again our Button package :> 1: use strict; 2: 3: package Button; - 4: use Qt; - 5: use Qt::isa qw(Qt::PushButton); - 6: use Qt::attributes qw(itsTime); - 7: use Qt::slots + 4: use TQt; + 5: use TQt::isa qw(TQt::PushButton); + 6: use TQt::attributes qw(itsTime); + 7: use TQt::slots 8: wasClicked => [], 9: change => ['int', 'int']; - 10: use Qt::signals + 10: use TQt::signals 11: changeIt => ['int', 'int']; 12: 13: sub NEW 14: { 15: shift->SUPER::NEW(@_[0..2]); - 16: itsTime = Qt::Time; + 16: itsTime = TQt::Time; 17: itsTime->start; - 18: this->connect(this, SIGNAL 'clicked()', SLOT 'wasClicked()'); - 19: this->connect(this, SIGNAL 'changeIt(int,int)', SLOT 'change(int,int)'); + 18: this->connect(this, TQT_SIGNAL 'clicked()', TQT_SLOT 'wasClicked()'); + 19: this->connect(this, TQT_SIGNAL 'changeIt(int,int)', TQT_SLOT 'change(int,int)'); 20: } 21: 22: sub wasClicked @@ -545,7 +545,7 @@ B<As an example, lets rewrite again our Button package :> In this package, we define two extra slots and one extra signal. -We know from the Qt Documentation that a clicked PushButton emits a C<clicked()> +We know from the TQt Documentation that a clicked PushButton emits a C<clicked()> signal, so we connect it to our new slot at line 18. We also connect our signal C<changeIt> to our own C<change> slot- which is @@ -556,9 +556,9 @@ triggers the C<wasClicked()> slot. C<wasClicked> then proceeds to emit the C<changeIt(int,int)> signal [l.27], hence triggering the C<change(int,int)> slot with two arguments. -Finally, since PerlQt-3.008, an alternative syntax can be used to declare Signals and Slots: +Finally, since PerlTQt-3.008, an alternative syntax can be used to declare Signals and Slots: - sub a_slot : SLOT(int, QString) + sub a_slot : TQT_SLOT(int, TQString) { $int = shift; $string = shift; @@ -567,19 +567,19 @@ Finally, since PerlQt-3.008, an alternative syntax can be used to declare Signal and - sub a_signal : SIGNAL(QString); + sub a_signal : TQT_SIGNAL(TQString); This syntax is perfectly compatible with the traditional -C<use Qt::signals> and C<use Qt::slots> declarations. +C<use TQt::signals> and C<use TQt::slots> declarations. Eventually, it can prove good programming practice to mix both syntaxes, by first declaring -Signals/Slots with C<use Qt::slots/signals>, then repeat this declaration +Signals/Slots with C<use TQt::slots/signals>, then repeat this declaration in the actual implementation with the second syntax. Declarations will be checked for consistency at compile time, and any mismatch in arguments would trigger a warning. -=head1 RAD prototyping with Qt Designer and Puic +=head1 RAD prototyping with TQt Designer and Puic =head2 Introduction @@ -587,27 +587,27 @@ in arguments would trigger a warning. =item * Note: -As of PerlQt-3.008, a separate PerlQt plugin for Qt Designer is available, -bringing full integration, syntax highlighting, code completion and allowing to run/debug your PerlQt project +As of PerlTQt-3.008, a separate PerlTQt plugin for TQt Designer is available, +bringing full integration, syntax highlighting, code completion and allowing to run/debug your PerlTQt project entirely from the Designer GUI. Nevertheless, the below is still accurate with regard to puic command line interaction -and with regard to using Qt Designer I<without> the specific plugin. +and with regard to using TQt Designer I<without> the specific plugin. =back -As efficient and intuitive as Qt can be, building a complete GUI from scratch +As efficient and intuitive as TQt can be, building a complete GUI from scratch is often a tedious task. -Hopefully, Qt comes with a very sophisticated GUI Builder named Qt +Hopefully, TQt comes with a very sophisticated GUI Builder named TQt Designer, which is close to a complete integrated development environment. It features Project management, drag'n drop GUI building, a complete object browser, graphical interconnection of signals and slots, and much much more. -Qt Designer's output is XML which can be parsed by several command line tools, -among whose is B<puic> (the PerlQt User Interface Compiler). +TQt Designer's output is XML which can be parsed by several command line tools, +among whose is B<puic> (the PerlTQt User Interface Compiler). Assuming you have already built an interface file with the Designer, -translating it to a PerlQt program is simply a matter of issuing +translating it to a PerlTQt program is simply a matter of issuing one command : puic -x -o program.pl program.ui @@ -632,7 +632,7 @@ If you need to B<embed images or icons>, it can be done in two ways =item * Inline embedding For this, you need to check the "Edit->Form Settings->Pixmaps->Save inline" -checkbox inside Qt Designer. +checkbox inside TQt Designer. Then : puic -x -o F<program.pl> F<program.ui> =item * Image Collection @@ -643,7 +643,7 @@ puic -o F<Collection.pm> -embed F<unique_identifier> F<image-1> ... F<image-n> Then add a C<use Collection.pm> statement to your program's main package. -If you've created a project file in Qt Designer, and added all images +If you've created a project file in TQt Designer, and added all images you want to group (through "Project->Image Collection"), you'll find all those images inside the directory where your project file (*.pro) is stored, under /images. @@ -671,7 +671,7 @@ Instead, you may : =item * Write slots implementation in the Designer -In Qt Designer, select the I<Source> tab of the B<Object Explorer>. +In TQt Designer, select the I<Source> tab of the B<Object Explorer>. There you can see a tree-like representation of your classes. Now if you double-click on the I<Slots/public> entry, you are prompted with a dialog where you can create a new custom slot for @@ -744,8 +744,8 @@ or =head1 More development tools -PerlQt comes bundled with two simple programs that can help you to find your way through -the Qt API: +PerlTQt comes bundled with two simple programs that can help you to find your way through +the TQt API: =head2 pqtapi @@ -756,14 +756,14 @@ pqtapi is a commandline driven introspection tool. options: -r <re> : find all functions matching regular expression/keyword <re> -i : together with -r, performs a case insensitive search - -v : print PerlQt and Qt versions + -v : print PerlTQt and TQt versions -h : print this help message e.g: $>pqtapi -ir 'setpoint.* int' - void QCanvasLine::setPoints(int, int, int, int) - void QPointArray::setPoint(uint, int, int) + void TQCanvasLine::setPoints(int, int, int, int) + void TQPointArray::setPoint(uint, int, int) =head2 pqtsh @@ -780,7 +780,7 @@ Templated classes aren't available yet (classes derived from templated classes a =head1 Credits -PerlQt-3 is (c) 2002 Ashley Winters (and (c) 2003 Germain Garand) +PerlTQt-3 is (c) 2002 Ashley Winters (and (c) 2003 Germain Garand) Kalyptus and the Smoke generation engine are (c) David Faure and Richard Dale @@ -791,9 +791,9 @@ The mentioned software is released under the GNU Public Licence v.2 or later. =head1 Appendix 1 : C++ conventions and their Perl counterpart -Whenever you want to use a class/method described in Qt's -L<documentation|"http://doc.trolltech.com"> (see also the 'assistant' program bundled with Qt) -from PerlQt, you need to follow some simple translation rules. +Whenever you want to use a class/method described in TQt's +L<documentation|"http://doc.trolltech.com"> (see also the 'assistant' program bundled with TQt) +from PerlTQt, you need to follow some simple translation rules. =over 4 @@ -803,9 +803,9 @@ from PerlQt, you need to follow some simple translation rules. =item * -All classnames are changed from a B<Q> prefix in Qt to a B<Qt::> prefix +All classnames are changed from a B<Q> prefix in TQt to a B<TQt::> prefix in Perl. -e.g: QComboBox is named Qt::ComboBox within PerlQt. +e.g: TQComboBox is named TQt::ComboBox within PerlTQt. =back @@ -816,15 +816,15 @@ e.g: QComboBox is named Qt::ComboBox within PerlQt. =item * Functions referenced as B<static> are accessed directly, and not through -an object. Thus the static function Foo in class QBar would be accessed from -PerlQt as +an object. Thus the static function Foo in class TQBar would be accessed from +PerlTQt as - Qt::Bar::Foo( arg-1,...,arg-n); + TQt::Bar::Foo( arg-1,...,arg-n); The only notable exceptions are : - qApp() will map to Qt::app() - qVersion() will map to Qt::version() # not really needed anymore: we have qVersion(). See Global Functions below. + qApp() will map to TQt::app() + qVersion() will map to TQt::version() # not really needed anymore: we have qVersion(). See Global Functions below. =item * @@ -834,7 +834,7 @@ e.g: $widget->show; -There are no fundamental differences between methods and signals, however PerlQt +There are no fundamental differences between methods and signals, however PerlTQt provides the B<emit> keyword as a convenient mnemonic, so that it is clear you are emitting a signal : @@ -849,17 +849,17 @@ are emitting a signal : =item * By value When an argument isn't preceded by the B<&> or B<*> character, it is passed by -value. For all basic types such as int, char, float and double, PerlQt will +value. For all basic types such as int, char, float and double, PerlTQt will automatically convert litteral and scalar values to the corresponding C++ type. Thus for a constructor prototype written as follow in the documentation : - QSize ( int w, int h ) + TQSize ( int w, int h ) You'd say : - Qt::Size(8, 12); + TQt::Size(8, 12); =item * By reference @@ -868,12 +868,12 @@ When an argument is preceded by the B<&> character, it means a reference to an object or to a type is expected. You may either provide a variable name or a temporary object : - $keyseq = Qt::keySequence( &Qt::CTRL + &Qt::F3 ); + $keyseq = TQt::keySequence( &TQt::CTRL + &TQt::F3 ); $widget->setAccel( $keyseq ); or - $widget->setAccel(Qt::keySequence( &Qt::CTRL + &Qt::F3 ); + $widget->setAccel(TQt::keySequence( &TQt::CTRL + &TQt::F3 ); If the argument isn't qualified as B<const> (constant), it means the passed object may be altered during the process - you must then provide a variable. @@ -902,7 +902,7 @@ where C<Strange> is the generic enumeration name, and C<Apple>, C<Orange>, C<Lemon> its possible values, which are only aliases for numbers (here 0, 1 and 2). -Access to enumerations values in Perl Qt is very similar to a static function +Access to enumerations values in Perl TQt is very similar to a static function call. In fact, it B<is> a static function call. Therefore, since you probably want to avoid some readability problems, we @@ -910,110 +910,110 @@ recommend the use of the alternate function call syntax : C<&function>. Lets now go back to our C<Strange> example. -If its definition was encountered in the class C<QFruits>, you'd write from -PerlQt : +If its definition was encountered in the class C<TQFruits>, you'd write from +PerlTQt : - $apple_plus_orange = &Qt::Fruit::Apple + &Qt::Fruit::Orange; + $apple_plus_orange = &TQt::Fruit::Apple + &TQt::Fruit::Orange; =item Operators -Within PerlQt, B<operators overloading> works transparently. -If a given operator is overloaded in a Qt class (which means using it triggers a custom method) -it will behave identically in PerlQt. +Within PerlTQt, B<operators overloading> works transparently. +If a given operator is overloaded in a TQt class (which means using it triggers a custom method) +it will behave identically in PerlTQt. Beware though that due to limitations of the Smoke binding library, not all overloaded operators are -available in PerlQt. +available in PerlTQt. You can check the availability of a given operator by using the pqtapi program. Also, due to outstanding differences between C++'s and Perl's object paradigm, the copy constructor operator (a.k.a '=') has been disabled. e.g-1: '+=' overload - $p1 = Qt::Point(10, 10) - $p2 = Qt::Point(30,40) + $p1 = TQt::Point(10, 10) + $p2 = TQt::Point(30,40) $p2 += $p1; # $p2 becomes (40,50) e.g-2: '<<' overload - $f = Qt::File("example"); + $f = TQt::File("example"); $f->open( IO_WriteOnly ); # see 'Constants' below - $s = Qt::TextStream( $f ); + $s = TQt::TextStream( $f ); $s << "What can I do with " << 12 << " apples?"; =item Constants -Qt doesn't use many constants, but there is at least one place where they are used : for setting +TQt doesn't use many constants, but there is at least one place where they are used : for setting Input/Output flags on files. -In order to avoid the namespace pollution induced by global constants, PerlQt group them in the B<Qt::constants> module. +In order to avoid the namespace pollution induced by global constants, PerlTQt group them in the B<TQt::constants> module. For instance, requesting the importation of all IO constants into the current namespace would be done with: - use Qt::constants; + use TQt::constants; You may also import specific symbols: - use Qt::constants qw( IO_ReadOnly IO_WriteOnly ); + use TQt::constants qw( IO_ReadOnly IO_WriteOnly ); =item Global Functions -Qt has also some utilitarian functions such as bitBlt, qCompress, etc. +TQt has also some utilitarian functions such as bitBlt, qCompress, etc. Those were global scope functions and have been grouped in a common namespace: -C<Qt::GlobalSpace>. +C<TQt::GlobalSpace>. Hence, you shall access this namespace either with a fully qualified call: - Qt::GlobalSpace::qUncompress( $buffer ) + TQt::GlobalSpace::qUncompress( $buffer ) Or directly, after importation in the current namespace: - use Qt::GlobalSpace; + use TQt::GlobalSpace; qUncompress( $buffer ) Of course, you may selectively import a few functions: - use Qt::GlobalSpace qw( qUncompress bitBlt ) + use TQt::GlobalSpace qw( qUncompress bitBlt ) B<Note:> GlobalSpace has also operators, such has the one performing an addition on two -Qt::Point(). Those operators are called automatically. +TQt::Point(). Those operators are called automatically. e.g: - $p1 = Qt::Point(10, 10) + Qt::Point(20, 20) + $p1 = TQt::Point(10, 10) + TQt::Point(20, 20) =back =head1 Appendix 2 : Internationalization -PerlQt handles internationalization by always converting B<QString> back to B<utf8> in Perl. +PerlTQt handles internationalization by always converting B<TQString> back to B<utf8> in Perl. -Conversions from Perl strings to QStrings are made according to context : +Conversions from Perl strings to TQStrings are made according to context : =over 4 =item * If the Perl string is already utf8-encoded -then the string will be converted straight to QString. +then the string will be converted straight to TQString. This is the most convenient and seemless way of internationalizing your application. Typically, one would just enable the use of utf8 in source code with the C<use utf8> pragma and write its application with an utf8 aware editor. =item * If the string isn't tagged as utf8, and the B<use locale> pragma is not set -then the string will be converted to QString's utf8 from B<ISO-Latin-1>. +then the string will be converted to TQString's utf8 from B<ISO-Latin-1>. =item * If the string isn't tagged as utf8 and the B<use locale> pragma is set -then the string will be converted to QString's utf8 according to the currently set B<locale>. +then the string will be converted to TQString's utf8 according to the currently set B<locale>. =back Once a string contains utf8, you can convert it back to any locale by setting up B<converters> : - $tr1=Qt::TextCodec::codecForLocale(); # this one will use current locale - $tr2=Qt::TextCodec::codecForName("KOI8-R"); # that one forces a specific locale (Russian) + $tr1=TQt::TextCodec::codecForLocale(); # this one will use current locale + $tr2=TQt::TextCodec::codecForName("KOI8-R"); # that one forces a specific locale (Russian) - print $tr1->fromUnicode(Qt::DateTime::currentDateTime()->toString)."\n\n"; + print $tr1->fromUnicode(TQt::DateTime::currentDateTime()->toString)."\n\n"; print $tr2->fromUnicode($my_utf8_string); Or, with Perl >= 5.8.0, you may use Perl's B<Encode> modules (see C<perldoc Encode>). @@ -1023,20 +1023,20 @@ Or, with Perl >= 5.8.0, you may use Perl's B<Encode> modules (see C<perldoc Enco Developers who don't want to use UTF-8 or want to temporarily disable UTF-8 marshalling for handling legacy programs may use the B<use bytes> pragma (and the corresponding B<no bytes>). -Within the scope of this pragma, QStrings are marshalled back to ISO-Latin1 (default) or to your locale +Within the scope of this pragma, TQStrings are marshalled back to ISO-Latin1 (default) or to your locale (if B<use locale> has been set). Frivole use of this pragma is strongly discouraged as it ruins worldwide standardization efforts. =head1 Appendix 3 : Debugging Channels -The B<Qt::debug> module offers various debugging channels/features. +The B<TQt::debug> module offers various debugging channels/features. - use Qt::debug; + use TQt::debug; - use Qt::debug qw|calls autoload verbose|; + use TQt::debug qw|calls autoload verbose|; -With the simple C<use Qt::debug> statement, the B<verbose> and B<ambiguous> channels are activated. +With the simple C<use TQt::debug> statement, the B<verbose> and B<ambiguous> channels are activated. If you specify a list of channels within the use statement, then only the specified channels will be enabled. B<Available channels :> @@ -1056,33 +1056,33 @@ Together with B<ambiguous>, tell you the nearest matches in case a method or function call fails. e.g: - use Qt; - use Qt::debug; - $a= Qt::Application(\@ARGV); + use TQt; + use TQt::debug; + $a= TQt::Application(\@ARGV); $a->libraryPath("foo"); --- No method to call for : - QApplication::libraryPath('foo') + TQApplication::libraryPath('foo') Closer candidates are : - static void QApplication::addLibraryPath(const QString&) - static QStringList QApplication::libraryPaths() - static void QApplication::removeLibraryPath(const QString&) - static void QApplication::setLibraryPaths(const QStringList&) + static void TQApplication::addLibraryPath(const TQString&) + static TQStringList TQApplication::libraryPaths() + static void TQApplication::removeLibraryPath(const TQString&) + static void TQApplication::setLibraryPaths(const TQStringList&) =item * calls -For every call, tell what corresponding Qt method is called +For every call, tell what corresponding TQt method is called (detailing the arguments if B<verbose> is on). =item * autoload Track the intermediate code between a method invocation in Perl -and its resolution to either a Qt or Perl call. +and its resolution to either a TQt or Perl call. =item * gc Give informations about garbage collection -whenever a Qt object is deleted and/or a Perl object is destroyed +whenever a TQt object is deleted and/or a Perl object is destroyed =item * virtual @@ -1100,46 +1100,46 @@ Enable all channels A marshaller is a piece of "glue code" translating a given datatype to another. -Within PerlQt, most Qt objects keep their object nature, so that one may invoke methods on them. +Within PerlTQt, most TQt objects keep their object nature, so that one may invoke methods on them. However, some classes and datatypes map so naturally to some Perl types that keeping their object nature would would feel unnatural and clumsy. -For instance, instead of returning a Qt::StringList object, which would require an iterator to retrieve its content, -PerlQt will translate it to an array reference containing all the object's strings. +For instance, instead of returning a TQt::StringList object, which would require an iterator to retrieve its content, +PerlTQt will translate it to an array reference containing all the object's strings. -In the other way, instead of providing a Qt::StringList object as an argument of a method, one would simply +In the other way, instead of providing a TQt::StringList object as an argument of a method, one would simply provide the reference to an array of Perl strings. -Here is the list of Marshallers as of PerlQt-3.008 : +Here is the list of Marshallers as of PerlTQt-3.008 : ----------------------------------------------------------------- float, double <=> Perl real (NV) char, uchar, int, uint, enum long, ulong, short, ushort <=> Perl integer (IV) - QString, -&, -* => Perl string (utf8) - QString, -&, -* <= Perl string (utf8 or iso-latin1 or locale) - QCString, -&, -* <=> Perl string (utf8 or bytes, according to content or "bytes" pragma) - QByteArray, -&, -* <=> Perl string (bytes) - QStringList, -&, -* => Reference to an array of Perl strings (utf8) - QString, -&, -* => Perl string (utf8 or iso-latin1 or locale) + TQString, -&, -* => Perl string (utf8) + TQString, -&, -* <= Perl string (utf8 or iso-latin1 or locale) + TQCString, -&, -* <=> Perl string (utf8 or bytes, according to content or "bytes" pragma) + TQByteArray, -&, -* <=> Perl string (bytes) + TQStringList, -&, -* => Reference to an array of Perl strings (utf8) + TQString, -&, -* => Perl string (utf8 or iso-latin1 or locale) int&, -* <=> Perl integer (IV) bool&, -* <=> Perl boolean char* <=> Perl string (bytes) char** <= Reference to an array of Perl strings (bytes) uchar* <= Perl string (bytes) - QRgb* <= Reference to an array of Perl integers (IV) - QCOORD* <= Reference to an array of Perl integers (IV) + TQRgb* <= Reference to an array of Perl integers (IV) + TQCOORD* <= Reference to an array of Perl integers (IV) void* <=> Reference to a Perl integer (IV) - QValueList<int>, - *, - & <=> Reference to an array of Perl integers (IV) - QCanvasItemList, - *, - & => Reference to an array of Qt::CanvasItem - QWidgetList, - *, - & <=> Reference to an array of Qt::Widget - QObjectList, - *, - & <=> Reference to an array of Qt::Object - QFileInfoList, - *, - & <=> Reference to an array of Qt::FileInfo - QPtrList<QTab>, - *, - & <=> Reference to an array of Qt::Tab - QPtrList<QToolBar>, - *, - & <=> Reference to an array of Qt::ToolBar - QPtrList<QNetworkOperation>, - *, - & <=> Reference to an array of Qt::NetworkOperation - QPtrList<QDockWindow>, - *, - & <=> Reference to an array of Qt::DockWindow - (QUObject*) + TQValueList<int>, - *, - & <=> Reference to an array of Perl integers (IV) + TQCanvasItemList, - *, - & => Reference to an array of TQt::CanvasItem + TQWidgetList, - *, - & <=> Reference to an array of TQt::Widget + TQObjectList, - *, - & <=> Reference to an array of TQt::Object + TQFileInfoList, - *, - & <=> Reference to an array of TQt::FileInfo + TQPtrList<TQTab>, - *, - & <=> Reference to an array of TQt::Tab + TQPtrList<TQToolBar>, - *, - & <=> Reference to an array of TQt::ToolBar + TQPtrList<TQNetworkOperation>, - *, - & <=> Reference to an array of TQt::NetworkOperation + TQPtrList<TQDockWindow>, - *, - & <=> Reference to an array of TQt::DockWindow + (TQUObject*) |