X-Git-Url: http://git.draconx.ca/gitweb/gob-dx.git/blobdiff_plain/4c9cb9b99991c36920bd17e366e2128d1b22eb6e..6e77e91bbb048a0ee1a072715c0ce808c169ab38:/doc/gob.1.in diff --git a/doc/gob.1.in b/doc/gob.1.in index 51f8a12..afd3bf5 100644 --- a/doc/gob.1.in +++ b/doc/gob.1.in @@ -94,13 +94,13 @@ is one of the features of the GTK+ object system. You need to define a get and a set handler. They are fragments of C code that will be used to get the value or set the value of the argument. Inside them you can use the define ARG to which you assign the data or get the data. You can also use -the identifier "this" as pointer to the object instance. The type is +the identifier "self" as pointer to the object instance. The type is defined as one of the gtk type enums, but without the GTK_TYPE_ prefix. For example: .nf public int height; - argument INT height set { this->height = ARG; } get { ARG = this->height; }; + argument INT height set { self->height = ARG; } get { ARG = self->height; }; .fi .PP @@ -111,7 +111,7 @@ without the GTK_ARG_ prefix. For example: .nf public int height; - argument (CONSTRUCT) INT height get { ARG = this->height; }; + argument (CONSTRUCT) INT height get { ARG = self->height; }; .fi .PP @@ -128,7 +128,7 @@ to add code to the constructors or you can just leave them out. Argument lists: .PP For all but the init and init_class methods, you use the -following syntax for arguments. The first argument can be just "this", +following syntax for arguments. The first argument can be just "self", which gob will translate into a pointer to the object instance. The rest of the arguments are very similar to normal C arguments. If the typename is an object pointer you should use the syntax defined above @@ -146,11 +146,11 @@ numeric arguments for being a certain value. The test can be a <,>,<=,>= != or ==. Example: .nf - public int foo(this, int h (check > 0 < 11), Gtk:Widget *w (check null type)) + public int foo(self, int h (check > 0 < 11), Gtk:Widget *w (check null type)) .fi .PP -This will be the prototype of a function which has a this pointer +This will be the prototype of a function which has a self pointer as the first argument, an integer argument which will be checked and has to be more then 0 and less then 11, and a pointer to a GtkWidget object instance and it is checked for being null and the type will also be @@ -167,7 +167,7 @@ code enclosed in braces {}. The braces will not be printed into the output, they just delimit the string. For example .nf - public void * get_something(this, int i (check >= 0)) onerror NULL { + public void * get_something(self, int i (check >= 0)) onerror NULL { ... } @@ -181,7 +181,8 @@ so that one can override the method in derived methods. They can be empty which makes calling the methods he same as public methods. This type of method is just a little bit "slower" then normal functions, but not as slow as signals. You define them by using "virtual" keyword before the -prototype. +prototype. If you put the keyword "private" right after the "virtual" +keyword, the wrapper will not be a public method, but a private one. .PP Signals: .PP @@ -193,8 +194,8 @@ you define a signal. One thing is when the default handler will be run, first or last. You specify that by "first" or "last" right after the "signal" keyword. Then you need to define the gtk enum types (again without the GTK_TYPE_ prefix). For that you define the return types -and the types of arguments after the "this" pointer (not including the -"this" pointer). You put it in the following syntax " ( ()". If the return type is void, the type should be "NONE", the same should be for the argument list. The rest of the prototype is the same as for other method types. The body can also be empty, and @@ -203,30 +204,37 @@ signal just like a public method. Example: .nf signal first INT(POINTER,INT) - int do_something(this, Gtk:Widget *w (check null type), int length) + int do_something(self, Gtk:Widget *w (check null type), int length) { ... } or - signal last NONE(NONE) void foo(this); + signal last NONE(NONE) void foo(self); .fi .PP +If you don't want the wrapper that emits the signal to be public, you can +include the keyword "private" after the "signal" keyword. This will make +the wrapper a normal private method. +.PP +If you don't define a "first" or a "last", the default will be taken as +"last". +.PP Override methods: .PP If you need to override some method (a signal or a virtual method of some class in the parent tree of the new object), you can define and override method. After the "override" keyword, you should put the typename of the class you are overriding a method from. Other then that -it is the same as for other methods. The "this" pointer in this case +it is the same as for other methods. The "self" pointer in this case should be the type of the method you are overriding so that you don't get warnings during compilation. Example: .nf override (Gtk:Container) void - add (Gtk:Container *this (check null type), Gtk:Widget *wid (check null type)) + add (Gtk:Container *self (check null type), Gtk:Widget *wid (check null type)) { ... } @@ -239,15 +247,15 @@ have to type the class name before each call. Example: .nf private int - foo(this) + foo(self) { - return this->len; + return self->len; } private int - bar(this,int i) + bar(self,int i) { - return foo(this) + i; + return foo(self) + i; } .fi @@ -271,8 +279,8 @@ will fetch a new object, so a fairly standard new method would look like: .SH BUGS .PP The generated header file is included as the first file in the .c file, no -matter what. This means that you will have to put things that need to be included -before that, into an %h{ } section. +matter what. This means that you will have to put things that need to be +included before that, into an %h{ } section. .SH AUTHOR .PP