diff options
Diffstat (limited to 'ksirc/puke/HOWTO-PUKE.pod')
| -rw-r--r-- | ksirc/puke/HOWTO-PUKE.pod | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/ksirc/puke/HOWTO-PUKE.pod b/ksirc/puke/HOWTO-PUKE.pod index cf44e77e..9a09acd4 100644 --- a/ksirc/puke/HOWTO-PUKE.pod +++ b/ksirc/puke/HOWTO-PUKE.pod @@ -11,7 +11,7 @@ under Linux. Puke's a generic protocol allowing dsirc to communicate with ksirc. Communications works over a unix domain socket between multiple client dsirc process's to a single ksirc process. All communications -is done via a variable length message with the following layout: +is done via a variable length message with the following tqlayout: =begin text @@ -67,18 +67,18 @@ supporting perl5-oop object. =head2 2.1 C++ Widget code The C++ code must be able to hand all required settings and messages -for the widget. Each new widget iherites it's parent and so forth -allowing for a nice oop layout. The widget structure the author is +for the widget. Each new widget iherites it's tqparent and so forth +allowing for a nice oop tqlayout. The widget structure the author is following is the same as Qt's. Their seems to work well, why re-invent the wheel? =item 2.1.1 General Layout, etc Figure where your new widget goes in the heirachy. If it's a simple -Qt widget, I recommend using their existing layout. Man pages list +Qt widget, I recommend using their existing tqlayout. Man pages list what widgets inherit what. -The general idea behind the widget layout should be to be to provide +The general idea behind the widget tqlayout should be to be to provide all the functionality of the widget to dsirc perl script. Incoming messages are handled via the messageHandler and ALL messages should return an ACK with current state info. @@ -106,7 +106,7 @@ These set and return your widget. If you care about inheritance, which you should, all these functions should be virtual. (Since we are using pointers to PWidget's -everywhere, it's a good bet you want your children's overriden +everywhere, it's a good bet you want your tqchildren's overriden functions called, not yours) The structure internally will have to hold a local copy of the widget, @@ -117,27 +117,27 @@ destroyed. createWidget is defined as: -PWidget *createWidget(widgetId *pwi, PWidget *parent); +PWidget *createWidget(widgetId *pwi, PWidget *tqparent); It is called everytime a new widget of yours is required. The widgetId will be the identifier for your widget and must be kept for all future commands. PWidget::setWidgetId(pwi) should be called to -set the widget id. The *parent is the parent of the current widget. +set the widget id. The *tqparent is the tqparent of the current widget. Generally PWidget->widget() is passed to the contructor of your -widget. If it's 0, there is no parent. Simeplfied code for a the +widget. If it's 0, there is no tqparent. Simeplfied code for a the PFrame is: =begin text extern "C" { -PWidget *createWidget(widgetId *pwi, PWIdget *parent); +PWidget *createWidget(widgetId *pwi, PWIdget *tqparent); } -PWidget *createWidget(widgetId *pwi, PWIdget *parent){ +PWidget *createWidget(widgetId *pwi, PWIdget *tqparent){ QFrame *f; - PFrame *pf = new PFrame(parent); - if(parent != 0){ - f = new QFrame(parent->widget()); + PFrame *pf = new PFrame(tqparent); + if(tqparent != 0){ + f = new QFrame(tqparent->widget()); } else{ f = new QPFrame(); @@ -149,13 +149,13 @@ PWidget *createWidget(widgetId *pwi, PWIdget *parent){ =end text -Note: you have to check parent for null since calling NULL->widget() +Note: you have to check tqparent for null since calling NULL->widget() results in Bad Things (tm). =item 2.1.3 messageHandler This receives all commands, etc. It should process required commands, -if a command is unkown pass it to the parent. PFrame example: +if a command is unkown pass it to the tqparent. PFrame example: =begin text @@ -186,9 +186,9 @@ void PFrame::messageHandler(int fd, PukeMessage *pm) { Both these functions should be overriden and return your widget type, and set your widget. For setWidget you should connect required -signals and eventFilters you are using. +Q_SIGNALS and eventFilters you are using. -Make sure to call the parents setWidget in setWidget so it can connect +Make sure to call the tqparents setWidget in setWidget so it can connect filters etc. BEWARE: You might get the widget into setWidget being null (from the @@ -222,7 +222,7 @@ Call the destructor as such: delete widget(); setWidget(0); -This will clear the widget from now and all parents and delete it. +This will clear the widget from now and all tqparents and delete it. you never want it deleted twice. (deleting 0 won't hurt) =head2 2.2 The Perl code |