From 0e004c696b0e68b2cff37a4c3315b022a35eaf43 Mon Sep 17 00:00:00 2001 From: Perberos Date: Thu, 1 Dec 2011 22:24:23 -0300 Subject: moving from https://github.com/perberos/mate-desktop-environment --- docs/Makefile.am | 25 + docs/architecture.txt | 160 +++++ docs/caja-connect-server.1 | 50 ++ docs/caja-file-management-properties.1 | 49 ++ docs/caja-internals.pdf | Bin 0 -> 307912 bytes docs/caja-internals.sxw | Bin 0 -> 59282 bytes docs/caja-io.txt | 255 +++++++ docs/caja.1 | 77 ++ docs/caja.faq | 7 + docs/dnd.txt | 92 +++ docs/key_mouse_navigation.txt | 112 +++ docs/load-states.dia | Bin 0 -> 2026 bytes docs/recommended-books.html | 167 +++++ docs/reference/Makefile.am | 1 + docs/reference/Makefile.in | 646 +++++++++++++++++ docs/reference/libcaja-extension/Makefile.am | 84 +++ docs/reference/libcaja-extension/Makefile.in | 797 +++++++++++++++++++++ docs/reference/libcaja-extension/html/ch01.html | 63 ++ docs/reference/libcaja-extension/html/home.png | Bin 0 -> 654 bytes docs/reference/libcaja-extension/html/index.html | 66 ++ docs/reference/libcaja-extension/html/index.sgml | 170 +++++ docs/reference/libcaja-extension/html/ix01.html | 224 ++++++ docs/reference/libcaja-extension/html/left.png | Bin 0 -> 459 bytes .../libcaja-extension-caja-column-provider.html | 117 +++ .../html/libcaja-extension-caja-column.html | 182 +++++ .../libcaja-extension-caja-extension-types.html | 158 ++++ .../html/libcaja-extension-caja-file-info.html | 643 +++++++++++++++++ .../html/libcaja-extension-caja-info-provider.html | 252 +++++++ ...ja-extension-caja-location-widget-provider.html | 133 ++++ .../html/libcaja-extension-caja-menu-provider.html | 267 +++++++ .../html/libcaja-extension-caja-menu.html | 473 ++++++++++++ ...caja-extension-caja-property-page-provider.html | 131 ++++ .../html/libcaja-extension-caja-property-page.html | 148 ++++ .../html/libcaja-extension.devhelp | 118 +++ .../html/libcaja-extension.devhelp2 | 118 +++ docs/reference/libcaja-extension/html/pt01.html | 68 ++ docs/reference/libcaja-extension/html/right.png | Bin 0 -> 472 bytes docs/reference/libcaja-extension/html/style.css | 265 +++++++ docs/reference/libcaja-extension/html/up.png | Bin 0 -> 406 bytes .../libcaja-extension/libcaja-extension-docs.xml | 36 + .../libcaja-extension-overrides.txt | 0 .../libcaja-extension-sections.txt | 185 +++++ .../libcaja-extension/libcaja-extension.types | 11 + .../tmpl/caja-column-provider.sgml | 45 ++ .../libcaja-extension/tmpl/caja-column.sgml | 76 ++ .../tmpl/caja-extension-types.sgml | 78 ++ .../libcaja-extension/tmpl/caja-file-info.sgml | 257 +++++++ .../libcaja-extension/tmpl/caja-info-provider.sgml | 80 +++ .../tmpl/caja-location-widget-provider.sgml | 47 ++ .../libcaja-extension/tmpl/caja-menu-item.sgml | 22 + .../libcaja-extension/tmpl/caja-menu-provider.sgml | 86 +++ .../libcaja-extension/tmpl/caja-menu.sgml | 208 ++++++ .../tmpl/caja-property-page-provider.sgml | 46 ++ .../libcaja-extension/tmpl/caja-property-page.sgml | 60 ++ .../tmpl/libcaja-extension-unused.sgml | 0 docs/reference/libcaja-extension/version.xml.in | 1 + docs/smoketests.html | 555 ++++++++++++++ docs/state-machines.txt | 77 ++ docs/style-guide.html | 137 ++++ 59 files changed, 8125 insertions(+) create mode 100644 docs/Makefile.am create mode 100644 docs/architecture.txt create mode 100644 docs/caja-connect-server.1 create mode 100644 docs/caja-file-management-properties.1 create mode 100644 docs/caja-internals.pdf create mode 100644 docs/caja-internals.sxw create mode 100644 docs/caja-io.txt create mode 100644 docs/caja.1 create mode 100644 docs/caja.faq create mode 100644 docs/dnd.txt create mode 100644 docs/key_mouse_navigation.txt create mode 100644 docs/load-states.dia create mode 100644 docs/recommended-books.html create mode 100644 docs/reference/Makefile.am create mode 100644 docs/reference/Makefile.in create mode 100644 docs/reference/libcaja-extension/Makefile.am create mode 100644 docs/reference/libcaja-extension/Makefile.in create mode 100644 docs/reference/libcaja-extension/html/ch01.html create mode 100644 docs/reference/libcaja-extension/html/home.png create mode 100644 docs/reference/libcaja-extension/html/index.html create mode 100644 docs/reference/libcaja-extension/html/index.sgml create mode 100644 docs/reference/libcaja-extension/html/ix01.html create mode 100644 docs/reference/libcaja-extension/html/left.png create mode 100644 docs/reference/libcaja-extension/html/libcaja-extension-caja-column-provider.html create mode 100644 docs/reference/libcaja-extension/html/libcaja-extension-caja-column.html create mode 100644 docs/reference/libcaja-extension/html/libcaja-extension-caja-extension-types.html create mode 100644 docs/reference/libcaja-extension/html/libcaja-extension-caja-file-info.html create mode 100644 docs/reference/libcaja-extension/html/libcaja-extension-caja-info-provider.html create mode 100644 docs/reference/libcaja-extension/html/libcaja-extension-caja-location-widget-provider.html create mode 100644 docs/reference/libcaja-extension/html/libcaja-extension-caja-menu-provider.html create mode 100644 docs/reference/libcaja-extension/html/libcaja-extension-caja-menu.html create mode 100644 docs/reference/libcaja-extension/html/libcaja-extension-caja-property-page-provider.html create mode 100644 docs/reference/libcaja-extension/html/libcaja-extension-caja-property-page.html create mode 100644 docs/reference/libcaja-extension/html/libcaja-extension.devhelp create mode 100644 docs/reference/libcaja-extension/html/libcaja-extension.devhelp2 create mode 100644 docs/reference/libcaja-extension/html/pt01.html create mode 100644 docs/reference/libcaja-extension/html/right.png create mode 100644 docs/reference/libcaja-extension/html/style.css create mode 100644 docs/reference/libcaja-extension/html/up.png create mode 100644 docs/reference/libcaja-extension/libcaja-extension-docs.xml create mode 100644 docs/reference/libcaja-extension/libcaja-extension-overrides.txt create mode 100644 docs/reference/libcaja-extension/libcaja-extension-sections.txt create mode 100644 docs/reference/libcaja-extension/libcaja-extension.types create mode 100644 docs/reference/libcaja-extension/tmpl/caja-column-provider.sgml create mode 100644 docs/reference/libcaja-extension/tmpl/caja-column.sgml create mode 100644 docs/reference/libcaja-extension/tmpl/caja-extension-types.sgml create mode 100644 docs/reference/libcaja-extension/tmpl/caja-file-info.sgml create mode 100644 docs/reference/libcaja-extension/tmpl/caja-info-provider.sgml create mode 100644 docs/reference/libcaja-extension/tmpl/caja-location-widget-provider.sgml create mode 100644 docs/reference/libcaja-extension/tmpl/caja-menu-item.sgml create mode 100644 docs/reference/libcaja-extension/tmpl/caja-menu-provider.sgml create mode 100644 docs/reference/libcaja-extension/tmpl/caja-menu.sgml create mode 100644 docs/reference/libcaja-extension/tmpl/caja-property-page-provider.sgml create mode 100644 docs/reference/libcaja-extension/tmpl/caja-property-page.sgml create mode 100644 docs/reference/libcaja-extension/tmpl/libcaja-extension-unused.sgml create mode 100644 docs/reference/libcaja-extension/version.xml.in create mode 100644 docs/smoketests.html create mode 100644 docs/state-machines.txt create mode 100644 docs/style-guide.html (limited to 'docs') diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 00000000..71c07ba2 --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1,25 @@ +NULL = + +SUBDIRS = reference + +man_MANS = \ + caja.1 \ + caja-connect-server.1 \ + caja-file-management-properties.1 \ + $(NULL) + +EXTRA_DIST = \ + $(man_MANS) \ + architecture.txt \ + dnd.txt \ + load-states.dia \ + caja-internals.sxw \ + caja-internals.pdf \ + caja-io.txt \ + caja.faq \ + recommended-books.html \ + smoketests.html \ + state-machines.txt \ + style-guide.html \ + key_mouse_navigation.txt \ + $(NULL) diff --git a/docs/architecture.txt b/docs/architecture.txt new file mode 100644 index 00000000..83ce44fd --- /dev/null +++ b/docs/architecture.txt @@ -0,0 +1,160 @@ + + +* Caja Architecture Block Diagram + + ++-----------------------------------------------------------------------+ +| | +| caja application | +| | +| +----------------------------------------------------------+ | +| | | | +| | | | +| | CajaWindow | | +| | | | +| | | | +| +----------------------------------------------------------+ | +| | | | | +| | | | | +| \|/ \|/ \|/ | +| +---------------------+ +------------------+ +------------------+ | +| | | | | | | | +| | CajaContentView | | CajaMetaView | | CajaMetaView | | +| | | | | | | | +| +---------------------+ +------------------+ +------------------+ | +| /||\ /||\ /||\ | +| || || || | ++----------||---------------------------||------------------------||----+ + || || || + CORBA CORBA CORBA + || || || ++----------||------------------+ +------||-------------------+ +--||-----------------------+ +| \||/ | | \||/ | | \||/ | +| +--------------------------+ | | +-----------------------+ | | +-----------------------+ | +| | | | | | | | | | | | +| | CajaContentViewFrame | | | | CajaMetaViewFrame | | | | CajaMetaViewFrame | | +| | | | | | | | | | | | +| +--------------------------+ | | +-----------------------+ | | +-----------------------+ | +| | | | | | +| caja view component | | caja view component | | caja view component | +| | | | | | ++------------------------------+ +---------------------------+ +---------------------------+ + + + +* Caja Architecture Summary + +Caja is a general-purpose shell application for browsing arbitrary +content. It is implemented as `caja', a container application +which excercises overall control and provides chrome, and a number of +caja view components. These view components may use the +`libcaja' library to ease implementation. + +There are two types of views, content views and meta-views. A caja +window typically has one content view, which is displayed in the main +area of the window, and several meta-views, which are displayed on the +left, typically one at a time. The meta-views should be panels that +display information about the content being displayed, or that provide +navigation aids. + +However, ultimately multiple content views will be available and may +be switched by using an option menu. + +The caja application has a CajaWindow object for each window +it displays. The CajaWindow object provides various chrome and +uses a number of CajaView objects to communicate with view +components. The relationship between CajaWindow and the +CajaViews is mostly, but not completely one-way; primarily, the +window calls the view's methods and connects to its signals. + +The CajaView object serves as a proxy for a view component. It +provides a number of methods which correspond to the methods of the +Caja:View IDL interface, and translates calls to these methods to +CORBA calls to the view component. It also translates incoming calls +from the view component into signal emissions for a set of signals +that reflects that Caja:ViewFrame IDL interface. + +The CajaViewFrame object serves the corresponding role in the view +component. It provides methods that correspond to the +Caja:ViewFrame IDL interface which it translates to CORBA calls to +the app, and translates incoming CORBA calls from the app into signal +emissions which reflect the Caja:View IDL interface. + +Thus, whenever the application calls a CajaView method to +communicate with the view, a CORBA message is sent, and a signal is +emitted in the view component by CajaViewFrame. And conversely, +when the view component calls a CajaViewFrame method to +communicate with the app, a CORBA message is sent, and a signal is +emitted by CajaView. + + + +* Control Flow for a Location Change + +There are two possible cases. One case is when one of the views +requests a location change. The other is when the framework itself +initiates a location change. This may happen for various reasons, such +as the user typing a URI into the location bar, the user pressing the +Back or Forward buttons, or the user selecting a bookmark. + +** A view requests a location change + +For a view to initiate a location change, view-specific code in the +component calls caja_view_frame_request_location_change with the +appropriate arguments. This results in the "request_location_change" +signal being emitted by the corresponding CajaView object in the +app, as described above. The CajaWindow has connected to this +signal, so it is made aware of the request. The app may decide to +create a new window to display the new location, or to display it in +the same window. Either way, control proceeds largely as below. + + +** The framework carries out a location change + +When a CajaWindow has determined that it should carry out a +location change or load an initial location, it calls +`caja_window_change_location'. This routine begins by stopping any +previous in-progress loads. Then it determines the applicable content +views and meta-views. It then enters a state machine which results in +updating each view. + +When an individual view is being updated, one of two things may +happen. First, if the same view component is still applicable but the +location is different, `caja_view_notify_location_change' is +called which causes the "notify_location_change" signal to be emitted +in the view. If the same view component is no longer applicable, then +a new CajaView object is created, and the component for the proper +iid is loaded. Then `caja_view_notify_location_change' is called +to set it's initial location. + + +** Other component types + +Caja also has built-in support for viewing locations via MateComponent +subdocuments and MateComponent controls. This is implemented in the view and +transparent to the caja application. However, the underlying +architecture is different. + + + +* Other Communication + +The Caja:View and Caja:ViewFrame interfaces allow for other +communication as well. + +The view may request that the frame update the status message, +indicate a certain level of progress during loading, or display a +particular selection. + +The view frame may notify the view of a change in selection, tell it +to stop a load in progress, ask it to load or save its state, or ask +it to show its properties. + +Some conventions apply to the stop and progress operations. First, +`stop_location_change' should be an idempotent operation - that is, +performing it several times in a row should have the same effect as +performing it once, and it should not cause a crash. Second, the view +should send a `request_progress_change' message with a type of either +PROGRESS_DONE_OK or PROGRESS_DONE_ERROR when it is done loading, as +appropriate. This is necessary so that the stop button can be +desensitized when loading is complete. diff --git a/docs/caja-connect-server.1 b/docs/caja-connect-server.1 new file mode 100644 index 00000000..5ac49b70 --- /dev/null +++ b/docs/caja-connect-server.1 @@ -0,0 +1,50 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH caja-connect-server 1 "05 Jan 2008" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +caja-connect-server \- To Access a remote server +.SH SYNOPSIS +.B caja-connect-server +.RI [ options ] +.RI [ URI ] +.SH DESCRIPTION +This manual page documents briefly the +.B caja-connect-server +command. +.PP +Caja Connect Server is the connection manager for the MATE desktop. +.PP +You can use the file manager to access a remote server, be it an FTP site, +a Windows share, a WebDav server or an SSH server. +.SH OPTIONS +Caja follows the usual GNU command line syntax, with long options starting +with two dashes (`-'). A summary of options is included below. +.TP +.B \-\-help +Show a summary of options. +.TP +.B \-\-version +Show version. +.TP +Other standard MATE options not listed here are also supported. +.SH SEE ALSO +Caja Connect Server documentation can be found from the "Help" menu, or by pressing the +F1 key. Caja also has a website at http://www.gnome.org/projects/caja/ +.SH AUTHOR +This manual page was written by Julian Andres Klode for the +Debian GNU/Linux system (but may be used by others), based on a manpage by +Fernando Ribeiro . diff --git a/docs/caja-file-management-properties.1 b/docs/caja-file-management-properties.1 new file mode 100644 index 00000000..64db38d3 --- /dev/null +++ b/docs/caja-file-management-properties.1 @@ -0,0 +1,49 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH caja-file-management-properties 1 "05 Jan 2008" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +caja-file-management-properties \- File Management Preferences +.SH SYNOPSIS +.B caja-file-management-properties +.RI [ options ] +.SH DESCRIPTION +This manual page documents briefly the +.B caja-file-management-properties +command. +.PP +File Management Preferences allows an user to configure the way caja looks. +.PP +You can specify a default view, and select sort options and display options. +You can also specify default settings for icon views and list views. +.SH OPTIONS +Caja follows the usual GNU command line syntax, with long options starting +with two dashes (`-'). A summary of options is included below. +.TP +.B \-\-help +Show a summary of options. +.TP +.B \-\-version +Show version. +.TP +Other standard MATE options not listed here are also supported. +.SH SEE ALSO +File Management Preferences documentation can be found from the "Help" menu, or by pressing the +F1 key. Caja also has a website at http://www.gnome.org/projects/caja/ +.SH AUTHOR +This manual page was written by Julian Andres Klode for the +Debian GNU/Linux system (but may be used by others), based on a manpage by +Fernando Ribeiro . diff --git a/docs/caja-internals.pdf b/docs/caja-internals.pdf new file mode 100644 index 00000000..8d321f1d Binary files /dev/null and b/docs/caja-internals.pdf differ diff --git a/docs/caja-internals.sxw b/docs/caja-internals.sxw new file mode 100644 index 00000000..23f687ba Binary files /dev/null and b/docs/caja-internals.sxw differ diff --git a/docs/caja-io.txt b/docs/caja-io.txt new file mode 100644 index 00000000..2219d308 --- /dev/null +++ b/docs/caja-io.txt @@ -0,0 +1,255 @@ +Caja I/O Primer +draft ("Better Than Nothing") +2001-08-23 +Darin Adler + +The Caja shell, and the file manager inside it, does a lot of +I/O. Because of this, there are some special disciplines required when +writing Caja code. + +No I/O on the main thread + +To be able to respond to the user quickly, Caja needs to be +designed so that the main user input thread does not block. The basic +approach is to never do any disk I/O on the main thread. + +In practice, Caja code does assume that some disk I/O is fast, in +some cases intentionally and in other cases due to programmer +sloppiness. The typical assumption is that reading files from the +user's home directory and the installed files in the Caja datadir +are very fast, effectively instantaneous. + +So the general approach is to allow I/O for files that have file +system paths, assuming that the access to these files is fast, and to +prohibit I/O for files that have arbitrary URIs, assuming that access +to these could be arbitrarily slow. Although this works pretty well, +it is based on an incorrect assumption, because with NFS and other +kinds of abstract file systems, there can be arbitrarily slow parts of +the file system that have file system paths. + +For historical reasons, threading in Caja is done through the +mate-vfs asynchronous I/O abstraction rather than using threads +directly. This means that all the threads are created by mate-vfs, +and Caja code runs on the main thread only. Thus, the rule of +thumb is that synchronous mate-vfs operations like the ones in + are illegal in most Caja +code. Similarly, it's illegal to ask for a piece of information, say a +file size, and then wait until it arrives. The program's main thread +must be allowed to get back to the main loop and start asking for user +input again. + +How CajaFile is used to do this + +The CajaFile class presents an API for scheduling this +asynchronous I/O and dealing with the uncertainty of when the +information will be available. (It also does a few other things, but +that's the main service it provides.) When you want information about +a particular file or directory, you get the CajaFile object for +that item using caja_file_get. This operation, like most +CajaFile operations, is not allowed to do any disk I/O. Once you +have a CajaFile object, you can ask it questions like "What is +your file type?" by calling functions like +caja_file_get_file_type. However, for a newly created CajaFile +object the answer is almost certainly "I don't know." Each function +defines a default, which is the answer given for "I don't know." For +example, caja_file_get_type will return +MATE_VFS_FILE_TYPE_UNKNOWN if it doesn't yet know the type. + +It's worth taking a side trip to discuss the nature of the +CajaFile API. Since these classes are a private part of the +Caja implementation, we make no effort to have the API be +"complete" in an abstract sense. Instead we add operations as +necessary and give them the semantics that are most handy for our +purposes. For example, we could have a caja_file_get_size that +returns a special distinguishable value to mean "I don't know" or a +separate boolean instead of returning 0 for files where the size is +unknown. This is entirely motivated by pragmatic concerns. The intent +is that we tweak these calls as needed if the semantics aren't good +enough. + +Back to the newly created CajaFile object. If you actually need to +get the type, you need to arrange for that information to be fetched +from the file system. There are two ways to make this request. If you +are planning to display the type on an ongoing basis then you want to +tell the CajaFile that you'll be monitoring the file's type and want to +know about changes to it. If you just need one-time information about +the type then you'll want to be informed when the type is +discovered. The calls used for this are caja_file_monitor_add and +caja_file_call_when_ready respectively. Both of these calls take a +list of information needed about a file. If all you need is the file +type, for example, you would pass a list containing just +CAJA_FILE_ATTRIBUTE_FILE_TYPE (the attributes are defined in +caja-file-attributes.h). Not every call has a corresponding file +attribute type. We add new ones as needed. + +If you do a caja_file_monitor_add, you also typically connect to +the CajaFile object's changed signal. Each time any monitored +attribute changes, a changed signal is emitted. The caller typically +caches the value of the attribute that was last seen (for example, +what's displayed on screen) and does a quick check to see if the +attribute it cares about has changed. If you do a +caja_file_call_when_ready, you don't typically need to connect to +the changed signal, because your callback function will be called when +and if the requested information is ready. + +Both a monitor and a callback can be cancelled. For ease of +use, neither requires that you store an ID for +canceling. Instead, the monitor function uses an arbitrary client +pointer, which can be any kind of pointer that's known to not conflict +with other monitorers. Usually, this is a pointer to the monitoring +object, but it can also be, for example, a pointer to a global +variable. The call_when_ready function uses the callback function and callback +data to identify the particular callback to cancel. One advantage of the monitor +API is that it also lets the CajaFile framework know that the file +should be monitored for changes made outside Caja. This is how we +know when to ask FAM to monitor a file or directory for us. + +Lets review a few of the concepts: + +1) Nearly all CajaFile operations, like caja_file_get_type, + are not allowed to do any disk I/O. +2) To cause the actual I/O to be done, callers need to use set up + either a monitor or a callback. +3) The actual I/O is done by asynchronous mate-vfs calls, so the work + is done on another thread. + +To work with an entire directory of files at once, you use +a CajaDirectory object. With the CajaDirectory object you can +monitor a whole set of CajaFile objects at once, and you can +connect to a single "files_changed" signal that gets emitted whenever +files within the directory are modified. That way you don't have to +connect separately to each file you want to monitor. These calls are +also the mechanism for finding out which files are in a directory. In +most other respects, they are like the CajaFile calls. + +Caching, the good and the bad + +Another feature of the CajaFile class is the caching. If you keep +around a CajaFile object, it keeps around information about the +last known state of that file. Thus, if you call +caja_file_get_type, you might well get file type of the file found +at this location the last time you looked, rather than the information +about what the file type is now, or "unknown". There are some problems +with this, though. + +The first problem is that if wrong information is cached, you need +some way to "goose" the CajaFile object and get it to grab new +information. This is trickier than it might sound, because we don't +want to constantly distrust information we received just moments +before. To handle this, we have the +caja_file_invalidate_attributes and +caja_file_invalidate_all_attributes calls, as well as the +caja_directory_force_reload call. If some code in Caja makes a +change to a file that's known to affect the cached information, it can +call one of these to inform the CajaFile framework. Changes that +are made through the framework itself are automatically understood, so +usually these calls aren't necessary. + +The second problem is that it's hard to predict when information will +and won't be cached. The current rule that's implemented is that no +information is cached if no one retains a reference to the +CajaFile object. This means that someone else holding a +CajaFile object can subtly affect the semantics of whether you +have new data or not. Calling caja_file_call_when_ready or +caja_file_monitor_add will not invalidate the cache, but rather +will return you the already cached information. + +These problems are less pronounced when FAM is in use. With FAM, any +monitored file is highly likely to have accurate information, because +changes to the file will be noticed by FAM, and that in turn will +trigger new I/O to determine what the new status of the file is. + +Operations that change the file + +You'll note that up until this point, I've only discussed getting +information about the file, not making changes to it. CajaFile +also contains some APIs for making changes. There are two kinds of +these. + +The calls that change metadata are examples of the first kind. These +calls make changes to the internal state right away and schedule I/O +to write the changes out to the file system. There's no way to detect +if the I/O succeeds or fails, and as far as the client code is +concerned the change takes place right away. + +The calls that make other kinds of file system change are examples of +of the second kind. These calls take a +CajaFileOperationCallback. They are all cancellable, and they give +a callback when the operation completes, whether it succeeds or fails. + +Files that move + +When a file is moved, and the CajaFile framework knows it, then +the CajaFile and CajaDirectory objects follow the file rather +than staying stuck to the path. This has a direct influence on the +user interface of Caja -- if you move a directory, already-open +windows and property windows will follow the directory around. + +This means that keeping around a CajaFile object and keeping +around a URI for a file have different semantics, and there are +cases where one is the better choice and cases where the other is. + +Icons + +The current implementation of the Caja icon factory uses +synchronous I/O to get the icons and ignores these guidelines. The +only reason this doesn't ruin the Caja user experience is that it +also refuses to even try to fetch icons from URIs that don't +correspond to file system paths, which for most cases means it limits +itself to reading from the high-speed local disk. Don't ask me what +the repercussions of this are for NFS; do the research and tell me +instead! + +Slowness caused by asynchronous operations + +One danger in all this asynchronous I/O is that you might end up doing +repeated drawing and updating. If you go to display a file right +after asking for information about it, you might immediately show an +"unknown file type" icon. Then, milliseconds later, you may complete +the I/O and discover more information about the file, including the +appropriate icon. So you end up drawing the icon twice. There are a +number of strategies for preventing this problem. One of them is to +allow a bit of hysteresis and wait some fixed amount of time after +requesting the I/O before displaying the "unknown" state. One +strategy that's used in Caja is to wait until some basic +information is available until displaying anything. This might make +the program overall be faster, but it might make it seem slower, +because you don't see things right away. [What other strategies +are used in Caja now for this?] + +How to make Caja slow + +If you add I/O to the functions in CajaFile that are used simply +to fetch cached file information, you can make Caja incredibly I/O +intensive. On the other hand, the CajaFile API does not provide a +way to do arbitrary file reads, for example. So it can be tricky to +add features to Caja, since you first have to educate CajaFile +about how to do the I/O asynchronously and cache it, then request the +information and have some way to deal with the time when it's not yet +known. + +Adding new kinds of I/O usually involves working on the Caja I/O +state machine in caja-directory-async.c. If we changed Caja to +use threading instead of using mate-vfs asychronous operations, I'm +pretty sure that most of the changes would be here in this +file. That's because the external API used for CajaFile wouldn't +really have a reason to change. In either case, you'd want to schedule +work to be done, and get called back when the work is complete. + +[We probably need more about caja-directory-async.c here.] + +Future direction + +Some have suggested that by using threading directly in Caja +rather than using it indirectly through the mate-vfs async. calls, +we could simplify the I/O code in Caja. It's possible this would +make a big improvement, but it's also possible that this would primarily +affect the internals and implementation details of CajaFile and +still leave the rest of the Caja code the same. + +That's all for now + +This is a very rough early draft of this document. Let me know about +other topics that would be useful to be covered in here. + + -- Darin diff --git a/docs/caja.1 b/docs/caja.1 new file mode 100644 index 00000000..dc26cf6c --- /dev/null +++ b/docs/caja.1 @@ -0,0 +1,77 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH Caja 1 "24 May 2004" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +caja \- the MATE File Manager +.SH SYNOPSIS +.B caja +.RI [ options ] " URIs" ... +.br +.SH DESCRIPTION +This manual page documents briefly the +.B caja +command. This manual page was written for the Debian GNU/Linux distribution +because the original program does not have a manual page. +.PP +Caja is the file manager for the MATE desktop. +.br +.SH OPTIONS +Caja follows the usual GNU command line syntax, with long options starting +with two dashes (`-'). A summary of options is included below. +.TP +.B \-\-browser +Open a browser window. +.TP +.B \-c +.TP +.B \-\-check +Perform a quick set of self-check tests. +.TP +.B \-g +.TP +.B \-\-geometry=\fIGEOMETRY\fR +Create the initial window with the given geometry. +.TP +.B \-n +.TP +.B \-\-no-default-window +Only create windows for explicitly specified URIs. +.TP +.B \-\-no-desktop +Do not manage the desktop \(em ignore the preference set in the preferences +dialog. +.TP +.B \-q +.TP +.B \-\-quit +Quit Caja. +.TP +.B \-\-help +Show a summary of options. +.TP +.B \-\-version +Show Caja' version. +.TP +Other standard MATE options not listed here are also supported. +.SH SEE ALSO +Caja documentation can be found from the "Help" menu, or by pressing the +F1 key. Caja also has a website at +http://www.gnome.org/projects/caja/ +.SH AUTHOR +This manual page was written by Takuo KITAME and Dafydd +Harries for the Debian GNU/Linux system (but may be used +by others). diff --git a/docs/caja.faq b/docs/caja.faq new file mode 100644 index 00000000..47061ed4 --- /dev/null +++ b/docs/caja.faq @@ -0,0 +1,7 @@ +1. What is Caja ? + + Caja is an open-source file manager and graphical shell being + developed by Eazel, Inc. and others. It is part of the MATE project, and its + source code can be found in the MATE CVS repository. Caja is still in + the early stages of development. It will become an integral part of the + MATE desktop environment when it is finished. diff --git a/docs/dnd.txt b/docs/dnd.txt new file mode 100644 index 00000000..91467f33 --- /dev/null +++ b/docs/dnd.txt @@ -0,0 +1,92 @@ + Caja dnd code. + ------------------ + + +Caja dnd code is pretty compilcated, it has a lot of entry points and exit points. +Trying to clarify this now. + +You have to implement: + +If you are a source: + drag_begin + drag_end + drag_get_data + +If you are a destination: + drag_motion + drag_data_received + drag_drop + drag_leave + + + 1) Source + --------- + +if you are a source, you have to start a drag trough gtk_drag_begin. +This will call drag_begin signal in the source. +Then, when the destination calls gtk_drag_finish, drag_end will be +called in the source. + +drag_get_data will be called in the source when the destination +calls gtk_drag_get_data + +So, the source is very easy to write: it just needs to implement +those 3 signals and it should not have any memory management issue. + + + 2) Destination + -------------- + +Things get a little bit complicated. +when the dragging cursor gets in your window, you will get drag_motion +events. In caja, we do many things in this function: + - we start auto-scrolling if it is necessary. + - we call caja_*_ensure_data + - we prelight what is under the cursor if it can accept the drag. + - we try to expand what is under you if it can accept the drop (tree view) + +caja_*_ensure_data is vital. It calls gtk_drag_get_data to get the +data from the source. this allows the destination to store it in advance and use it +to know if what is under the cursor can accept the drag. + +Then, when the drop occurs, drag_drop is called on the destination. +drag_drop calls gtk_drag_get_data to get the data from the source to do its drop. +Then, drag_data_received is called when the data is received. +There, we can do the actual operation involved by the drop. +Also, just before the drag_drop event, a drag_leave event is triggered. + +If no drop occurs, a drag_leave occurs. + +So, drag_data_received does 2 things: it is called to get the data when we are +in motion and store it. It is also called to do the actual drop operation when +a drop happened. + +So, drag_data_received usually does 2 tests: it tests if the data was received. +If it was received, it stores it. +Then it tests if the drop occured just before. If so, it does the operation. + +This schema involves careful memory management: + 1) 2 exit points in destination. (drag_leave and drag_data_received) + 2) a lot of things are done in the callbacks so you have to take into + account all the possible code paths. + +To solve 1), we should use ONE destroy function which cleans up the drag data. +To solve 2), we have to be very careful where we call this fution from. + +This function has to clean up: + - the list of expanded nodes (tree view). + - the autoscroll code. + - the prelighting code. + It also has to set drag_info->need_to_destroy to TRUE + so that during the next drag in this widget, the + rest of the drag data is destroyed before begening the actual + new drag. + +When we receive a drag_motion, we first test for need_to_destroy and +destroy the rest of the data left from the previous drag. This code +has to destroy/reset: + - the drag data. + - the boolean vars used to store the state of the drag. + + + diff --git a/docs/key_mouse_navigation.txt b/docs/key_mouse_navigation.txt new file mode 100644 index 00000000..d111f43e --- /dev/null +++ b/docs/key_mouse_navigation.txt @@ -0,0 +1,112 @@ +This document describes the keyboard and mouse navigation model used +in the default Caja views in detail. This is useful as a a guide +for people implementing a Caja view or something else that wants +to have a feel that is compatible with Caja. + +*********** Icon view ******************** + +Keyboard: +========= + +Navigation and selection: + +When the focus is on the icon view you can move the currently selected +icon by using: + +Arrow Keys - moves one step in the direction +Tab - moves to the "next" icon in order (i.e. at the end of one row, + go to the first icon the next row) +Shift Tab - moves to the "previous" icon in order +Home - moves to the first icon +End - moves to the last icon + +In order to allow multiple selection the above navigation keys can be +combined with the Control key to move the keyboard focus without +affecting the current selection. If you use normal movement (not using +control) all the previously selected icons will be deselected. + +If several icons are selected and there is no keyboard focus you press +up or left will start navigating from the topmost leftmost icon, while +pressing down or right will start from the bottommost rightmost +icon. This works the same way if you hold down Control. + +To select or deselect an icon position the keyboard focus on it and +press ctlr-space. ctrl-space with no keyboard focus produces a +keyboard focus at the first selected icon, or the first one if none +are selected. + +In manual layout (and especially, on the desktop) the keyboard arrow +keys work in a slightly different way. To allow all icons to be +reached the closest icon in the quadrant of the direction selected +will be used as the "next" icon when navigating. + +Other keyboard shortcuts: + +Return, Keypad Return - Activate the selected objects +Space (without control) - Activate the selected objects +Escape - Undo icon stretching if in progress + +Alt Left - go back +Alt Right - go forward +Alt Up - go up a directory +Alt Down - enter directory / activate selection + +Shift-F10 bring up context menu for selection, or the directory context menu if nothing is selected +Ctrl-F10 bring up context menu for directory + +Other key presses are used for typeahead search + +In rename mode: + +Escape - Cancel rename +Return, Keypad Return - Finish rename + +Mouse: +====== + +In double click mode: + +Clicking on an icon selects it and deselects all others on +BUTTON_PRESS. Dragging does the default dnd file operation. + +Clicking on blank space deselect all selected icons. Doesn't allow +dragging. + +Double clicking (both clicks on the same icon) with no modifiers +activates the clicked file. (And deselects the others due to the first +click.) + +Clicking when Control (Shift can also be used, which is not written +out below) is held down can be used to do multiple selections. + +Control-click on empty space does nothing. +Control-click on unselected icon selects it on BUTTON_PRESS +Control-click on selected icon de-selects it on BUTTON_RELEASE +Control-double click does nothing +Control can be held down while starting a drag + +While doing a drag modifers affect the operation the drag causes: +Control - Copy the files +Shift - Move the files +Alt - Open a menu with the available alternatives + +All the basic clicks are typically done with the left button, but can +be done with the other buttons to. [Do we want this?] However some of +the buttons also have special operations: + +Right-click on a selected icon opens the context menu for the selected +icons. +Right-click on empty space opens the context menu for the directory. +Middle-button drag always opens the menu with possible operations on +drop. + +In single click mode: + +Single click mode work just like double click mode except single +clicks on icons activate the icon on button release if you didn't +drag, didn't hold down for 1.5 secs or clicked twice within the +double-click time. + +*********** List view ******************** + +[TODO: Add stuff here] diff --git a/docs/load-states.dia b/docs/load-states.dia new file mode 100644 index 00000000..d650ceae Binary files /dev/null and b/docs/load-states.dia differ diff --git a/docs/recommended-books.html b/docs/recommended-books.html new file mode 100644 index 00000000..cedf95ab --- /dev/null +++ b/docs/recommended-books.html @@ -0,0 +1,167 @@ + + + +Eazel: Darin's Recommended Programming Books + + + + +

This document was really more for Eazel than for all Caja hackers, +but since the style guide references it, I checked it into the Caja CVS +for now. Later we can figure out what to do with it.

+ +

This document is left over from when Eazel was doing a program in C++. +Soon, I'll rearrange the document so it doesn't put all the C++ stuff first, +since C++ is immaterial for the current Caja project.

+ +

If you buy books from Amazon.com using the links on this page, Darin will get a small kickback from Amazon.

+ +

One of the main reasons for creating this list is that there are many poor C++ books out there. +I've picked out a small number of extremely useful books so you won't have to wade through the weaker ones.

+ +

C++ Reference Books

+ +

These books cover the C++ language and library. All of them except for the +C++ standard itself also contain useful introductory material. For some +programmers, these are enough to explain the features of the language.

+ +

The C++ Programming Language, Third Edition, +Bjarne Stroustrup. This is the book by the creator of the C++ language. This third edition is far superior +to the first two, and covers the ISO Standard version of the language in detail, including the library. +Any serious C++ programmer should read this book. There have been many corrections since the first printing, so get +the newest printing you can. Bjarne has supporting materials +for the book on the web, including the errata lists that enumerate all changes between printings.

+ +

The C++ Standard Library, +Nicolai M. Josuttis. This book has the best coverage of the library. There have been tons of others that cover +the library, or focus on the STL or streams. But Josuttis covers all these subjects better than any of his +predecessors. Since we use the library extensively in Eazel projects, this is a must read. +The author has some useful supporting materials on the web.

+ +

C++ Technique Books

+ +

These books are about specific programming techniques for writing code in C++. +They can help you understand idioms you'll find in our code. +This kind of idiomatic programming is important in C++, because the language +gives you so much freedom to write unusable, unmaintainable code.

+ +

Exceptional C++, +Herb Sutter. This is a collection of material that was originally part of Herb's +Guru of the Week. This includes much of the most +advanced C++ information available. I learned many of the most important techniques from Herb, including +the swap technique for writing safe assignment operators. Herb covers each topic thoroughly.

+ +

Ruminations on C++, +Andrew Koenig and Barbara Moo.

+ +

Effective C++, Second Edition +and More Effective C++, +Scott Meyers. These books contain a laundry list of important C++ idioms. The books are a bit less +important now than when they were first released, but still full of valuable stuff. There's also a +CD edition +(there's a copy of it on Rob's machine) +that contains both books in electronic form. The publisher's web site has a good collection of +supporting materials for both +the original and +the second book

+ +

The Design and Evolution of C++, +Bjarne Stroustrup. While this book doesn't prescribe any specific techniques, it will help you understand the +tradeoffs behind all the language features, and how C++ got to be what it is. I highly recommend it.

+ +

C++ Tutorial Books

+ +

These books explain C++ programming from scratch. These particular examples are so good that they +can be useful even for experienced programmers who already know C++ well.

+ +

Essential C++, +Stanley Lippman. This tutorial is much more useful than the longer and more complete works, like +C++ Primer. +It covers the features and the reasons for the features quite well. In particular, it has a good explanation +of references and pointers and why you'd use one or the other. It covers templates and exceptions fairly well.

+ +

Gtk Books

+ +

OK, so I'm not an expert on Gtk yet. But I'm becoming one.

+ +

Gtk+/Mate Application Development, +Havoc Pennington. I learned a lot from this book. But it's all Gtk+ and C; things are done +a bit differently with Gtk-- from C++. It's still worth reading.

+ +

Programming Technique Books

+ +

These books are valuable because of the ideas in them, but are not specific to a particular programming language or toolkit.

+ +

Refactoring, +Martin Fowler. This book outlines a philosophy of programming that we embrace at Eazel. The ideas +about changing existing code to improve it so it can be modified are extremely important. The ideas +about unit testing as a means to this end shape the way we use unit testing at Eazel. +All the examples in the book are in Java, but the ideas apply well to C++.

+ +

The Practice of Programming, +Brian Kernighan, Rob Pike. This book, by two of the most famous UNIX programmers, covers a lot of basic +programming smarts. I don't agree with everything they have to say, but the book is great as a whole.

+ +

Programming Pearls, Second Edition, +Jon Bentley. This classic has recently been updated with a second edition. I haven't read the second edition +yet, but I'm sure it's great. When I read it, I'll put more specific comments here.

+ +

Design Patterns. +There's also a CD edition +(there's a copy of it on Rob's machine).

+ +

Algorithms in C++, Third Edition, +Robert Sedgewick. The original version is in C. +There's also an upcoming Java version.

+ +

Books I Have Read, But Do Not Recommend

+ +

I've also read many books on these topics that were less useful than the ones listed above. +Here are a few that were not as exemplary. I won't try to sort out the ones that I found simply "not as useful as the best ones" +from the truly awful. If you see a book that's not on this list, it might be one I'd recommend. Maybe +I haven't read it.

+ +

C Interfaces and Implementations.

+ +

C++ IOStreams Handbook, +Steve Teale. Josuttis covers streams better.

+ +

Extreme Programming Explained. +My love for Refactoring had me excited about this one, but it was a disappointment.

+ +

Generic Programming and the STL, +Matt Austern. I don't know of anyone who knows more about the STL than Matt Austern, who's currently +maintaining the main implementation at SGI. But Josuttis covers the STL better.

+ +

Industrial Strength C++.

+ +

Inside the C++ Object Model.

+ +

Large-Scale C++ Software Design, +John Lakos.

+ +

Objects Unencapsulated: Java, Eiffel and C++??. +This is a basically an "Eiffel is great, C++ sucks" book. Some interesting insights, but a lot of sloppy thinking.

+ +

Books That Need Review

+ +

This is a list of possibly important books that I haven't checked out yet.

+ +

C++ Primer, Third Edition, +Stanley Lippman, Josee Lajoie. The earlier editions were good but not great. But I have reason +to believe that this one might be better than those were.

+ +

C++ Primer Answer Book. +I checked, and this answer book does go with the third edition of C++ Primer.

+ +

Design Patterns and Contracts.

+ +

Developing Linux Applications with GTK+ and GDK.

+ +

Linux Mate/Gtk Programming Bible.

+ +

Sams Teach Yourself Gtk+ Programming in 21 Days.

+ + + + diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am new file mode 100644 index 00000000..4c6935b3 --- /dev/null +++ b/docs/reference/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = libcaja-extension diff --git a/docs/reference/Makefile.in b/docs/reference/Makefile.in new file mode 100644 index 00000000..cc8a1150 --- /dev/null +++ b/docs/reference/Makefile.in @@ -0,0 +1,646 @@ +# Makefile.in generated by automake 1.11.1 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, +# Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +subdir = docs/reference +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/m4/gtk-doc.m4 \ + $(top_srcdir)/m4/intltool.m4 $(top_srcdir)/m4/libtool.m4 \ + $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ + $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/configure.in +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +CONFIG_CLEAN_VPATH_FILES = +AM_V_GEN = $(am__v_GEN_$(V)) +am__v_GEN_ = $(am__v_GEN_$(AM_DEFAULT_VERBOSITY)) +am__v_GEN_0 = @echo " GEN " $@; +AM_V_at = $(am__v_at_$(V)) +am__v_at_ = $(am__v_at_$(AM_DEFAULT_VERBOSITY)) +am__v_at_0 = @ +SOURCES = +DIST_SOURCES = +RECURSIVE_TARGETS = all-recursive check-recursive dvi-recursive \ + html-recursive info-recursive install-data-recursive \ + install-dvi-recursive install-exec-recursive \ + install-html-recursive install-info-recursive \ + install-pdf-recursive install-ps-recursive install-recursive \ + installcheck-recursive installdirs-recursive pdf-recursive \ + ps-recursive uninstall-recursive +RECURSIVE_CLEAN_TARGETS = mostlyclean-recursive clean-recursive \ + distclean-recursive maintainer-clean-recursive +AM_RECURSIVE_TARGETS = $(RECURSIVE_TARGETS:-recursive=) \ + $(RECURSIVE_CLEAN_TARGETS:-recursive=) tags TAGS ctags CTAGS \ + distdir +ETAGS = etags +CTAGS = ctags +DIST_SUBDIRS = $(SUBDIRS) +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +am__relativize = \ + dir0=`pwd`; \ + sed_first='s,^\([^/]*\)/.*$$,\1,'; \ + sed_rest='s,^[^/]*/*,,'; \ + sed_last='s,^.*/\([^/]*\)$$,\1,'; \ + sed_butlast='s,/*[^/]*$$,,'; \ + while test -n "$$dir1"; do \ + first=`echo "$$dir1" | sed -e "$$sed_first"`; \ + if test "$$first" != "."; then \ + if test "$$first" = ".."; then \ + dir2=`echo "$$dir0" | sed -e "$$sed_last"`/"$$dir2"; \ + dir0=`echo "$$dir0" | sed -e "$$sed_butlast"`; \ + else \ + first2=`echo "$$dir2" | sed -e "$$sed_first"`; \ + if test "$$first2" = "$$first"; then \ + dir2=`echo "$$dir2" | sed -e "$$sed_rest"`; \ + else \ + dir2="../$$dir2"; \ + fi; \ + dir0="$$dir0"/"$$first"; \ + fi; \ + fi; \ + dir1=`echo "$$dir1" | sed -e "$$sed_rest"`; \ + done; \ + reldir="$$dir2" +ACLOCAL = @ACLOCAL@ +ACLOCAL_AMFLAGS = @ACLOCAL_AMFLAGS@ +ALL_CFLAGS = @ALL_CFLAGS@ +ALL_LIBS = @ALL_LIBS@ +ALL_LINGUAS = @ALL_LINGUAS@ +AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +AR = @AR@ +AS = @AS@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CAJA_EXTENSION_VERSION_INFO = @CAJA_EXTENSION_VERSION_INFO@ +CATALOGS = @CATALOGS@ +CATOBJEXT = @CATOBJEXT@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CORE_CFLAGS = @CORE_CFLAGS@ +CORE_LIBS = @CORE_LIBS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DATADIRNAME = @DATADIRNAME@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DISABLE_DEPRECATED_CFLAGS = @DISABLE_DEPRECATED_CFLAGS@ +DLLTOOL = @DLLTOOL@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +ENABLE_EMPTY_VIEW = @ENABLE_EMPTY_VIEW@ +ENABLE_PROFILER = @ENABLE_PROFILER@ +EXEEXT = @EXEEXT@ +EXEMPI_CFLAGS = @EXEMPI_CFLAGS@ +EXEMPI_LIBS = @EXEMPI_LIBS@ +EXEMPI_NEW_API_CFLAGS = @EXEMPI_NEW_API_CFLAGS@ +EXEMPI_NEW_API_LIBS = @EXEMPI_NEW_API_LIBS@ +EXIF_CFLAGS = @EXIF_CFLAGS@ +EXIF_LIBS = @EXIF_LIBS@ +FGREP = @FGREP@ +GAIL_REQUIRED = @GAIL_REQUIRED@ +GETTEXT_PACKAGE = @GETTEXT_PACKAGE@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_REQUIRED = @GLIB_REQUIRED@ +GMOFILES = @GMOFILES@ +GMSGFMT = @GMSGFMT@ +GREP = @GREP@ +GTKDOC_CHECK = @GTKDOC_CHECK@ +GTKDOC_DEPS_CFLAGS = @GTKDOC_DEPS_CFLAGS@ +GTKDOC_DEPS_LIBS = @GTKDOC_DEPS_LIBS@ +GTKDOC_MKPDF = @GTKDOC_MKPDF@ +GTKDOC_REBASE = @GTKDOC_REBASE@ +GTK_REQUIRED = @GTK_REQUIRED@ +HTML_DIR = @HTML_DIR@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INSTOBJEXT = @INSTOBJEXT@ +INTLLIBS = @INTLLIBS@ +INTLTOOL_EXTRACT = @INTLTOOL_EXTRACT@ +INTLTOOL_MERGE = @INTLTOOL_MERGE@ +INTLTOOL_PERL = @INTLTOOL_PERL@ +INTLTOOL_UPDATE = @INTLTOOL_UPDATE@ +INTROSPECTION_CFLAGS = @INTROSPECTION_CFLAGS@ +INTROSPECTION_COMPILER = @INTROSPECTION_COMPILER@ +INTROSPECTION_GENERATE = @INTROSPECTION_GENERATE@ +INTROSPECTION_GIRDIR = @INTROSPECTION_GIRDIR@ +INTROSPECTION_LIBS = @INTROSPECTION_LIBS@ +INTROSPECTION_MAKEFILE = @INTROSPECTION_MAKEFILE@ +INTROSPECTION_SCANNER = @INTROSPECTION_SCANNER@ +INTROSPECTION_TYPELIBDIR = @INTROSPECTION_TYPELIBDIR@ +LD = @LD@ +LDFLAGS = @LDFLAGS@ +LIBCAJA_EXTENSION_CFLAGS = @LIBCAJA_EXTENSION_CFLAGS@ +LIBCAJA_EXTENSION_LIBS = @LIBCAJA_EXTENSION_LIBS@ +LIBEGG_CFLAGS = @LIBEGG_CFLAGS@ +LIBEGG_LIBS = @LIBEGG_LIBS@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +MAINT = @MAINT@ +MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ +MATECONFTOOL = @MATECONFTOOL@ +MATECONF_SCHEMA_CONFIG_SOURCE = @MATECONF_SCHEMA_CONFIG_SOURCE@ +MATECONF_SCHEMA_FILE_DIR = @MATECONF_SCHEMA_FILE_DIR@ +MATE_DESKTOP_REQUIRED = @MATE_DESKTOP_REQUIRED@ +MKDIR_P = @MKDIR_P@ +MKINSTALLDIRS = @MKINSTALLDIRS@ +MSGFMT = @MSGFMT@ +MSGFMT_OPTS = @MSGFMT_OPTS@ +MSGMERGE = @MSGMERGE@ +NM = @NM@ +NMEDIT = @NMEDIT@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PANGO_REQUIRED = @PANGO_REQUIRED@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PERL = @PERL@ +PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ +POFILES = @POFILES@ +POSUB = @POSUB@ +PO_IN_DATADIR_FALSE = @PO_IN_DATADIR_FALSE@ +PO_IN_DATADIR_TRUE = @PO_IN_DATADIR_TRUE@ +RANLIB = @RANLIB@ +RENDER_LIBS = @RENDER_LIBS@ +SED = @SED@ +SELINUX_LIBS = @SELINUX_LIBS@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +UNIQUE_CFLAGS = @UNIQUE_CFLAGS@ +UNIQUE_LIBS = @UNIQUE_LIBS@ +UPDATE_MIME_DATABASE = @UPDATE_MIME_DATABASE@ +USE_NLS = @USE_NLS@ +VERSION = @VERSION@ +WARNING_CFLAGS = @WARNING_CFLAGS@ +XGETTEXT = @XGETTEXT@ +XMKMF = @XMKMF@ +XML_REQUIRED = @XML_REQUIRED@ +X_CFLAGS = @X_CFLAGS@ +X_EXTRA_LIBS = @X_EXTRA_LIBS@ +X_LIBS = @X_LIBS@ +X_PRE_LIBS = @X_PRE_LIBS@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ +SUBDIRS = libcaja-extension +all: all-recursive + +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu docs/reference/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --gnu docs/reference/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs + +# This directory's subdirectories are mostly independent; you can cd +# into them and run `make' without going through this Makefile. +# To change the values of `make' variables: instead of editing Makefiles, +# (1) if the variable is set in `config.status', edit `config.status' +# (which will cause the Makefiles to be regenerated when you run `make'); +# (2) otherwise, pass the desired values on the `make' command line. +$(RECURSIVE_TARGETS): + @fail= failcom='exit 1'; \ + for f in x $$MAKEFLAGS; do \ + case $$f in \ + *=* | --[!k]*);; \ + *k*) failcom='fail=yes';; \ + esac; \ + done; \ + dot_seen=no; \ + target=`echo $@ | sed s/-recursive//`; \ + list='$(SUBDIRS)'; for subdir in $$list; do \ + echo "Making $$target in $$subdir"; \ + if test "$$subdir" = "."; then \ + dot_seen=yes; \ + local_target="$$target-am"; \ + else \ + local_target="$$target"; \ + fi; \ + ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \ + || eval $$failcom; \ + done; \ + if test "$$dot_seen" = "no"; then \ + $(MAKE) $(AM_MAKEFLAGS) "$$target-am" || exit 1; \ + fi; test -z "$$fail" + +$(RECURSIVE_CLEAN_TARGETS): + @fail= failcom='exit 1'; \ + for f in x $$MAKEFLAGS; do \ + case $$f in \ + *=* | --[!k]*);; \ + *k*) failcom='fail=yes';; \ + esac; \ + done; \ + dot_seen=no; \ + case "$@" in \ + distclean-* | maintainer-clean-*) list='$(DIST_SUBDIRS)' ;; \ + *) list='$(SUBDIRS)' ;; \ + esac; \ + rev=''; for subdir in $$list; do \ + if test "$$subdir" = "."; then :; else \ + rev="$$subdir $$rev"; \ + fi; \ + done; \ + rev="$$rev ."; \ + target=`echo $@ | sed s/-recursive//`; \ + for subdir in $$rev; do \ + echo "Making $$target in $$subdir"; \ + if test "$$subdir" = "."; then \ + local_target="$$target-am"; \ + else \ + local_target="$$target"; \ + fi; \ + ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) $$local_target) \ + || eval $$failcom; \ + done && test -z "$$fail" +tags-recursive: + list='$(SUBDIRS)'; for subdir in $$list; do \ + test "$$subdir" = . || ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) tags); \ + done +ctags-recursive: + list='$(SUBDIRS)'; for subdir in $$list; do \ + test "$$subdir" = . || ($(am__cd) $$subdir && $(MAKE) $(AM_MAKEFLAGS) ctags); \ + done + +ID: $(HEADERS) $(SOURCES) $(LISP) $(TAGS_FILES) + list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ + unique=`for i in $$list; do \ + if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ + done | \ + $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ + mkid -fID $$unique +tags: TAGS + +TAGS: tags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ + $(TAGS_FILES) $(LISP) + set x; \ + here=`pwd`; \ + if ($(ETAGS) --etags-include --version) >/dev/null 2>&1; then \ + include_option=--etags-include; \ + empty_fix=.; \ + else \ + include_option=--include; \ + empty_fix=; \ + fi; \ + list='$(SUBDIRS)'; for subdir in $$list; do \ + if test "$$subdir" = .; then :; else \ + test ! -f $$subdir/TAGS || \ + set "$$@" "$$include_option=$$here/$$subdir/TAGS"; \ + fi; \ + done; \ + list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ + unique=`for i in $$list; do \ + if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ + done | \ + $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ + shift; \ + if test -z "$(ETAGS_ARGS)$$*$$unique"; then :; else \ + test -n "$$unique" || unique=$$empty_fix; \ + if test $$# -gt 0; then \ + $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ + "$$@" $$unique; \ + else \ + $(ETAGS) $(ETAGSFLAGS) $(AM_ETAGSFLAGS) $(ETAGS_ARGS) \ + $$unique; \ + fi; \ + fi +ctags: CTAGS +CTAGS: ctags-recursive $(HEADERS) $(SOURCES) $(TAGS_DEPENDENCIES) \ + $(TAGS_FILES) $(LISP) + list='$(SOURCES) $(HEADERS) $(LISP) $(TAGS_FILES)'; \ + unique=`for i in $$list; do \ + if test -f "$$i"; then echo $$i; else echo $(srcdir)/$$i; fi; \ + done | \ + $(AWK) '{ files[$$0] = 1; nonempty = 1; } \ + END { if (nonempty) { for (i in files) print i; }; }'`; \ + test -z "$(CTAGS_ARGS)$$unique" \ + || $(CTAGS) $(CTAGSFLAGS) $(AM_CTAGSFLAGS) $(CTAGS_ARGS) \ + $$unique + +GTAGS: + here=`$(am__cd) $(top_builddir) && pwd` \ + && $(am__cd) $(top_srcdir) \ + && gtags -i $(GTAGS_ARGS) "$$here" + +distclean-tags: + -rm -f TAGS ID GTAGS GRTAGS GSYMS GPATH tags + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done + @list='$(DIST_SUBDIRS)'; for subdir in $$list; do \ + if test "$$subdir" = .; then :; else \ + test -d "$(distdir)/$$subdir" \ + || $(MKDIR_P) "$(distdir)/$$subdir" \ + || exit 1; \ + fi; \ + done + @list='$(DIST_SUBDIRS)'; for subdir in $$list; do \ + if test "$$subdir" = .; then :; else \ + dir1=$$subdir; dir2="$(distdir)/$$subdir"; \ + $(am__relativize); \ + new_distdir=$$reldir; \ + dir1=$$subdir; dir2="$(top_distdir)"; \ + $(am__relativize); \ + new_top_distdir=$$reldir; \ + echo " (cd $$subdir && $(MAKE) $(AM_MAKEFLAGS) top_distdir="$$new_top_distdir" distdir="$$new_distdir" \\"; \ + echo " am__remove_distdir=: am__skip_length_check=: am__skip_mode_fix=: distdir)"; \ + ($(am__cd) $$subdir && \ + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$$new_top_distdir" \ + distdir="$$new_distdir" \ + am__remove_distdir=: \ + am__skip_length_check=: \ + am__skip_mode_fix=: \ + distdir) \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-recursive +all-am: Makefile +installdirs: installdirs-recursive +installdirs-am: +install: install-recursive +install-exec: install-exec-recursive +install-data: install-data-recursive +uninstall: uninstall-recursive + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-recursive +install-strip: + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + `test -z '$(STRIP)' || \ + echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-recursive + +clean-am: clean-generic clean-libtool mostlyclean-am + +distclean: distclean-recursive + -rm -f Makefile +distclean-am: clean-am distclean-generic distclean-tags + +dvi: dvi-recursive + +dvi-am: + +html: html-recursive + +html-am: + +info: info-recursive + +info-am: + +install-data-am: + +install-dvi: install-dvi-recursive + +install-dvi-am: + +install-exec-am: + +install-html: install-html-recursive + +install-html-am: + +install-info: install-info-recursive + +install-info-am: + +install-man: + +install-pdf: install-pdf-recursive + +install-pdf-am: + +install-ps: install-ps-recursive + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-recursive + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-recursive + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-recursive + +pdf-am: + +ps: ps-recursive + +ps-am: + +uninstall-am: + +.MAKE: $(RECURSIVE_CLEAN_TARGETS) $(RECURSIVE_TARGETS) ctags-recursive \ + install-am install-strip tags-recursive + +.PHONY: $(RECURSIVE_CLEAN_TARGETS) $(RECURSIVE_TARGETS) CTAGS GTAGS \ + all all-am check check-am clean clean-generic clean-libtool \ + ctags ctags-recursive distclean distclean-generic \ + distclean-libtool distclean-tags distdir dvi dvi-am html \ + html-am info info-am install install-am install-data \ + install-data-am install-dvi install-dvi-am install-exec \ + install-exec-am install-html install-html-am install-info \ + install-info-am install-man install-pdf install-pdf-am \ + install-ps install-ps-am install-strip installcheck \ + installcheck-am installdirs installdirs-am maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am tags tags-recursive \ + uninstall uninstall-am + + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/docs/reference/libcaja-extension/Makefile.am b/docs/reference/libcaja-extension/Makefile.am new file mode 100644 index 00000000..a73131d5 --- /dev/null +++ b/docs/reference/libcaja-extension/Makefile.am @@ -0,0 +1,84 @@ +## Process this file with automake to produce Makefile.in + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# The name of the module, e.g. 'glib'. +DOC_MODULE=libcaja-extension + +# The top-level SGML file. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting the functions and macros. +# e.g. DOC_SOURCE_DIR=../../../libcaja-extension +DOC_SOURCE_DIR=$(top_srcdir)/libcaja-extension + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS=--type-init-func="g_type_init()" + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED" + +# Extra options to supply to gtkdoc-mkdb. +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +FIXXREF_OPTIONS= + +# Used for dependencies. The docs will be rebuilt if any of these change. +HFILE_GLOB=$(top_srcdir)/libcaja-extension/*.h +CFILE_GLOB=$(top_srcdir)/libcaja-extension/*.c + +# Header files to ignore when scanning. +IGNORE_HFILES = \ + config.h \ + caja-extension-i18n.h \ + $(NULL) + +# Images to copy into HTML directory +HTML_IMAGES = + +content_files = \ + version.xml \ + $(NULL) + +# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded +# These files must be listed here *and* in content_files +# e.g. expand_content_files=running.sgml +expand_content_files= \ + $(NULL) + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +# Only needed if you are using gtkdoc-scangobj to dynamically query widget +# signals and properties. +# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +GTKDOC_CFLAGS = \ + $(GTK_DEBUG_FLAGS) \ + -I$(srcdir) \ + -I$(top_srcdir) \ + -I$(top_srcdir)/libcaja-extension \ + -I$(top_builddir) \ + -I$(top_builddir)/libcaja-extension \ + $(LIBCAJA_EXTENSION_CFLAGS) \ + $(NULL) + +GTKDOC_LIBS = \ + $(top_builddir)/libcaja-extension/libcaja-extension.la \ + $(LIBCAJA_EXTENSION_LIBS) \ + $(NULL) + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += version.xml.in diff --git a/docs/reference/libcaja-extension/Makefile.in b/docs/reference/libcaja-extension/Makefile.in new file mode 100644 index 00000000..992926ee --- /dev/null +++ b/docs/reference/libcaja-extension/Makefile.in @@ -0,0 +1,797 @@ +# Makefile.in generated by automake 1.11.1 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, +# Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +# -*- mode: makefile -*- + +#################################### +# Everything below here is generic # +#################################### +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkglibexecdir = $(libexecdir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in \ + $(srcdir)/version.xml.in $(top_srcdir)/gtk-doc.make +subdir = docs/reference/libcaja-extension +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/m4/gtk-doc.m4 \ + $(top_srcdir)/m4/intltool.m4 $(top_srcdir)/m4/libtool.m4 \ + $(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \ + $(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \ + $(top_srcdir)/configure.in +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = version.xml +CONFIG_CLEAN_VPATH_FILES = +AM_V_GEN = $(am__v_GEN_$(V)) +am__v_GEN_ = $(am__v_GEN_$(AM_DEFAULT_VERBOSITY)) +am__v_GEN_0 = @echo " GEN " $@; +AM_V_at = $(am__v_at_$(V)) +am__v_at_ = $(am__v_at_$(AM_DEFAULT_VERBOSITY)) +am__v_at_0 = @ +SOURCES = +DIST_SOURCES = +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +ACLOCAL_AMFLAGS = @ACLOCAL_AMFLAGS@ +ALL_CFLAGS = @ALL_CFLAGS@ +ALL_LIBS = @ALL_LIBS@ +ALL_LINGUAS = @ALL_LINGUAS@ +AMTAR = @AMTAR@ +AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +AR = @AR@ +AS = @AS@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CAJA_EXTENSION_VERSION_INFO = @CAJA_EXTENSION_VERSION_INFO@ +CATALOGS = @CATALOGS@ +CATOBJEXT = @CATOBJEXT@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CORE_CFLAGS = @CORE_CFLAGS@ +CORE_LIBS = @CORE_LIBS@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DATADIRNAME = @DATADIRNAME@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +DISABLE_DEPRECATED_CFLAGS = @DISABLE_DEPRECATED_CFLAGS@ +DLLTOOL = @DLLTOOL@ +DSYMUTIL = @DSYMUTIL@ +DUMPBIN = @DUMPBIN@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +ENABLE_EMPTY_VIEW = @ENABLE_EMPTY_VIEW@ +ENABLE_PROFILER = @ENABLE_PROFILER@ +EXEEXT = @EXEEXT@ +EXEMPI_CFLAGS = @EXEMPI_CFLAGS@ +EXEMPI_LIBS = @EXEMPI_LIBS@ +EXEMPI_NEW_API_CFLAGS = @EXEMPI_NEW_API_CFLAGS@ +EXEMPI_NEW_API_LIBS = @EXEMPI_NEW_API_LIBS@ +EXIF_CFLAGS = @EXIF_CFLAGS@ +EXIF_LIBS = @EXIF_LIBS@ +FGREP = @FGREP@ +GAIL_REQUIRED = @GAIL_REQUIRED@ +GETTEXT_PACKAGE = @GETTEXT_PACKAGE@ +GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_REQUIRED = @GLIB_REQUIRED@ +GMOFILES = @GMOFILES@ +GMSGFMT = @GMSGFMT@ +GREP = @GREP@ +GTKDOC_CHECK = @GTKDOC_CHECK@ +GTKDOC_DEPS_CFLAGS = @GTKDOC_DEPS_CFLAGS@ +GTKDOC_DEPS_LIBS = @GTKDOC_DEPS_LIBS@ +GTKDOC_MKPDF = @GTKDOC_MKPDF@ +GTKDOC_REBASE = @GTKDOC_REBASE@ +GTK_REQUIRED = @GTK_REQUIRED@ +HTML_DIR = @HTML_DIR@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +INSTOBJEXT = @INSTOBJEXT@ +INTLLIBS = @INTLLIBS@ +INTLTOOL_EXTRACT = @INTLTOOL_EXTRACT@ +INTLTOOL_MERGE = @INTLTOOL_MERGE@ +INTLTOOL_PERL = @INTLTOOL_PERL@ +INTLTOOL_UPDATE = @INTLTOOL_UPDATE@ +INTROSPECTION_CFLAGS = @INTROSPECTION_CFLAGS@ +INTROSPECTION_COMPILER = @INTROSPECTION_COMPILER@ +INTROSPECTION_GENERATE = @INTROSPECTION_GENERATE@ +INTROSPECTION_GIRDIR = @INTROSPECTION_GIRDIR@ +INTROSPECTION_LIBS = @INTROSPECTION_LIBS@ +INTROSPECTION_MAKEFILE = @INTROSPECTION_MAKEFILE@ +INTROSPECTION_SCANNER = @INTROSPECTION_SCANNER@ +INTROSPECTION_TYPELIBDIR = @INTROSPECTION_TYPELIBDIR@ +LD = @LD@ +LDFLAGS = @LDFLAGS@ +LIBCAJA_EXTENSION_CFLAGS = @LIBCAJA_EXTENSION_CFLAGS@ +LIBCAJA_EXTENSION_LIBS = @LIBCAJA_EXTENSION_LIBS@ +LIBEGG_CFLAGS = @LIBEGG_CFLAGS@ +LIBEGG_LIBS = @LIBEGG_LIBS@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LIBTOOL = @LIBTOOL@ +LIPO = @LIPO@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +MAINT = @MAINT@ +MAKEINFO = @MAKEINFO@ +MANIFEST_TOOL = @MANIFEST_TOOL@ +MATECONFTOOL = @MATECONFTOOL@ +MATECONF_SCHEMA_CONFIG_SOURCE = @MATECONF_SCHEMA_CONFIG_SOURCE@ +MATECONF_SCHEMA_FILE_DIR = @MATECONF_SCHEMA_FILE_DIR@ +MATE_DESKTOP_REQUIRED = @MATE_DESKTOP_REQUIRED@ +MKDIR_P = @MKDIR_P@ +MKINSTALLDIRS = @MKINSTALLDIRS@ +MSGFMT = @MSGFMT@ +MSGFMT_OPTS = @MSGFMT_OPTS@ +MSGMERGE = @MSGMERGE@ +NM = @NM@ +NMEDIT = @NMEDIT@ +OBJDUMP = @OBJDUMP@ +OBJEXT = @OBJEXT@ +OTOOL = @OTOOL@ +OTOOL64 = @OTOOL64@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_URL = @PACKAGE_URL@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PANGO_REQUIRED = @PANGO_REQUIRED@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PERL = @PERL@ +PKG_CONFIG = @PKG_CONFIG@ +PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@ +PKG_CONFIG_PATH = @PKG_CONFIG_PATH@ +POFILES = @POFILES@ +POSUB = @POSUB@ +PO_IN_DATADIR_FALSE = @PO_IN_DATADIR_FALSE@ +PO_IN_DATADIR_TRUE = @PO_IN_DATADIR_TRUE@ +RANLIB = @RANLIB@ +RENDER_LIBS = @RENDER_LIBS@ +SED = @SED@ +SELINUX_LIBS = @SELINUX_LIBS@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +UNIQUE_CFLAGS = @UNIQUE_CFLAGS@ +UNIQUE_LIBS = @UNIQUE_LIBS@ +UPDATE_MIME_DATABASE = @UPDATE_MIME_DATABASE@ +USE_NLS = @USE_NLS@ +VERSION = @VERSION@ +WARNING_CFLAGS = @WARNING_CFLAGS@ +XGETTEXT = @XGETTEXT@ +XMKMF = @XMKMF@ +XML_REQUIRED = @XML_REQUIRED@ +X_CFLAGS = @X_CFLAGS@ +X_EXTRA_LIBS = @X_EXTRA_LIBS@ +X_LIBS = @X_LIBS@ +X_PRE_LIBS = @X_PRE_LIBS@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +ac_ct_AR = @ac_ct_AR@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +am__include = @am__include@ +am__leading_dot = @am__leading_dot@ +am__quote = @am__quote@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target_alias = @target_alias@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# The name of the module, e.g. 'glib'. +DOC_MODULE = libcaja-extension + +# The top-level SGML file. +DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting the functions and macros. +# e.g. DOC_SOURCE_DIR=../../../libcaja-extension +DOC_SOURCE_DIR = $(top_srcdir)/libcaja-extension + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS = --type-init-func="g_type_init()" + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS = --deprecated-guards="G_DISABLE_DEPRECATED" + +# Extra options to supply to gtkdoc-mkdb. +MKDB_OPTIONS = --sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS = + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +FIXXREF_OPTIONS = + +# Used for dependencies. The docs will be rebuilt if any of these change. +HFILE_GLOB = $(top_srcdir)/libcaja-extension/*.h +CFILE_GLOB = $(top_srcdir)/libcaja-extension/*.c + +# Header files to ignore when scanning. +IGNORE_HFILES = \ + config.h \ + caja-extension-i18n.h \ + $(NULL) + + +# Images to copy into HTML directory +HTML_IMAGES = +content_files = \ + version.xml \ + $(NULL) + + +# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded +# These files must be listed here *and* in content_files +# e.g. expand_content_files=running.sgml +expand_content_files = \ + $(NULL) + + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +# Only needed if you are using gtkdoc-scangobj to dynamically query widget +# signals and properties. +# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +GTKDOC_CFLAGS = \ + $(GTK_DEBUG_FLAGS) \ + -I$(srcdir) \ + -I$(top_srcdir) \ + -I$(top_srcdir)/libcaja-extension \ + -I$(top_builddir) \ + -I$(top_builddir)/libcaja-extension \ + $(LIBCAJA_EXTENSION_CFLAGS) \ + $(NULL) + +GTKDOC_LIBS = \ + $(top_builddir)/libcaja-extension/libcaja-extension.la \ + $(LIBCAJA_EXTENSION_LIBS) \ + $(NULL) + +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_CC = $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_LD = $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) +@GTK_DOC_USE_LIBTOOL_FALSE@GTKDOC_RUN = +@GTK_DOC_USE_LIBTOOL_TRUE@GTKDOC_RUN = $(LIBTOOL) --mode=execute + +# We set GPATH here; this gives us semantics for GNU make +# which are more like other make's VPATH, when it comes to +# whether a source that is a target of one rule is then +# searched for in VPATH/GPATH. +# +GPATH = $(srcdir) +TARGET_DIR = $(HTML_DIR)/$(DOC_MODULE) +SETUP_FILES = \ + $(content_files) \ + $(DOC_MAIN_SGML_FILE) \ + $(DOC_MODULE)-sections.txt \ + $(DOC_MODULE)-overrides.txt + + +# This includes the standard gtk-doc make rules, copied by gtkdocize. + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST = $(HTML_IMAGES) $(SETUP_FILES) version.xml.in +DOC_STAMPS = setup-build.stamp scan-build.stamp tmpl-build.stamp sgml-build.stamp \ + html-build.stamp pdf-build.stamp \ + tmpl.stamp sgml.stamp html.stamp pdf.stamp + +SCANOBJ_FILES = \ + $(DOC_MODULE).args \ + $(DOC_MODULE).hierarchy \ + $(DOC_MODULE).interfaces \ + $(DOC_MODULE).prerequisites \ + $(DOC_MODULE).signals + +REPORT_FILES = \ + $(DOC_MODULE)-undocumented.txt \ + $(DOC_MODULE)-undeclared.txt \ + $(DOC_MODULE)-unused.txt + +CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS) +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_HTML_FALSE@HTML_BUILD_STAMP = +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_HTML_TRUE@HTML_BUILD_STAMP = html-build.stamp +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_PDF_FALSE@PDF_BUILD_STAMP = +@ENABLE_GTK_DOC_TRUE@@GTK_DOC_BUILD_PDF_TRUE@PDF_BUILD_STAMP = pdf-build.stamp +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(top_srcdir)/gtk-doc.make $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + ( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \ + && { if test -f $@; then exit 0; else break; fi; }; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu docs/reference/libcaja-extension/Makefile'; \ + $(am__cd) $(top_srcdir) && \ + $(AUTOMAKE) --gnu docs/reference/libcaja-extension/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(am__aclocal_m4_deps): +version.xml: $(top_builddir)/config.status $(srcdir)/version.xml.in + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d "$(distdir)/$$file"; then \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -fpR $(srcdir)/$$file "$(distdir)$$dir" || exit 1; \ + find "$(distdir)/$$file" -type d ! -perm -700 -exec chmod u+rwx {} \;; \ + fi; \ + cp -fpR $$d/$$file "$(distdir)$$dir" || exit 1; \ + else \ + test -f "$(distdir)/$$file" \ + || cp -p $$d/$$file "$(distdir)/$$file" \ + || exit 1; \ + fi; \ + done + $(MAKE) $(AM_MAKEFLAGS) \ + top_distdir="$(top_distdir)" distdir="$(distdir)" \ + dist-hook +check-am: all-am +check: check-am +all-am: Makefile all-local +installdirs: +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + `test -z '$(STRIP)' || \ + echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install +mostlyclean-generic: + +clean-generic: + -test -z "$(CLEANFILES)" || rm -f $(CLEANFILES) + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test . = "$(srcdir)" || test -z "$(CONFIG_CLEAN_VPATH_FILES)" || rm -f $(CONFIG_CLEAN_VPATH_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +clean: clean-am + +clean-am: clean-generic clean-libtool clean-local mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic distclean-local + +dvi: dvi-am + +dvi-am: + +html: html-am + +html-am: + +info: info-am + +info-am: + +install-data-am: install-data-local + +install-dvi: install-dvi-am + +install-dvi-am: + +install-exec-am: + +install-html: install-html-am + +install-html-am: + +install-info: install-info-am + +install-info-am: + +install-man: + +install-pdf: install-pdf-am + +install-pdf-am: + +install-ps: install-ps-am + +install-ps-am: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic \ + maintainer-clean-local + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-local + +.MAKE: install-am install-strip + +.PHONY: all all-am all-local check check-am clean clean-generic \ + clean-libtool clean-local dist-hook distclean \ + distclean-generic distclean-libtool distclean-local distdir \ + dvi dvi-am html html-am info info-am install install-am \ + install-data install-data-am install-data-local install-dvi \ + install-dvi-am install-exec install-exec-am install-html \ + install-html-am install-info install-info-am install-man \ + install-pdf install-pdf-am install-ps install-ps-am \ + install-strip installcheck installcheck-am installdirs \ + maintainer-clean maintainer-clean-generic \ + maintainer-clean-local mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \ + uninstall-local + + +@ENABLE_GTK_DOC_TRUE@all-local: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP) +@ENABLE_GTK_DOC_FALSE@all-local: + +docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP) + +$(REPORT_FILES): sgml-build.stamp + +#### setup #### + +setup-build.stamp: + -@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ + echo ' DOC Preparing build'; \ + files=`echo $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types`; \ + if test "x$$files" != "x" ; then \ + for file in $$files ; do \ + test -f $(abs_srcdir)/$$file && \ + cp -pu $(abs_srcdir)/$$file $(abs_builddir)/ || true; \ + done; \ + fi; \ + test -d $(abs_srcdir)/tmpl && \ + { cp -rp $(abs_srcdir)/tmpl $(abs_builddir)/; \ + chmod -R u+w $(abs_builddir)/tmpl; } \ + fi + @touch setup-build.stamp + +#### scan #### + +scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB) + @echo ' DOC Scanning header files' + @_source_dir='' ; \ + for i in $(DOC_SOURCE_DIR) ; do \ + _source_dir="$${_source_dir} --source-dir=$$i" ; \ + done ; \ + gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES) + @if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \ + echo " DOC Introspecting gobjects"; \ + scanobj_options=""; \ + gtkdoc-scangobj 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + scanobj_options="--verbose"; \ + fi; \ + fi; \ + CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \ + gtkdoc-scangobj $(SCANGOBJ_OPTIONS) $$scanobj_options --module=$(DOC_MODULE); \ + else \ + for i in $(SCANOBJ_FILES) ; do \ + test -f $$i || touch $$i ; \ + done \ + fi + @touch scan-build.stamp + +$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp + @true + +#### templates #### + +tmpl-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt + @echo ' DOC Rebuilding template files' + @gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS) + @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ + if test -w $(abs_srcdir) ; then \ + cp -rp $(abs_builddir)/tmpl $(abs_srcdir)/; \ + fi \ + fi + @touch tmpl-build.stamp + +tmpl.stamp: tmpl-build.stamp + @true + +$(srcdir)/tmpl/*.sgml: + @true + +#### xml #### + +sgml-build.stamp: tmpl.stamp $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files) + @echo ' DOC Building XML' + @-chmod -R u+w $(srcdir) + @_source_dir='' ; \ + for i in $(DOC_SOURCE_DIR) ; do \ + _source_dir="$${_source_dir} --source-dir=$$i" ; \ + done ; \ + gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $${_source_dir} $(MKDB_OPTIONS) + @touch sgml-build.stamp + +sgml.stamp: sgml-build.stamp + @true + +#### html #### + +html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) + @echo ' DOC Building HTML' + @rm -rf html + @mkdir html + @mkhtml_options=""; \ + gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + mkhtml_options="$$mkhtml_options --verbose"; \ + fi; \ + fi; \ + gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-path"; \ + if test "$(?)" = "0"; then \ + mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \ + fi; \ + cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) + -@test "x$(HTML_IMAGES)" = "x" || \ + for file in $(HTML_IMAGES) ; do \ + if test -f $(abs_srcdir)/$$file ; then \ + cp $(abs_srcdir)/$$file $(abs_builddir)/html; \ + fi; \ + if test -f $(abs_builddir)/$$file ; then \ + cp $(abs_builddir)/$$file $(abs_builddir)/html; \ + fi; \ + done; + @echo ' DOC Fixing cross-references' + @gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) + @touch html-build.stamp + +#### pdf #### + +pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) + @echo ' DOC Building PDF' + @rm -f $(DOC_MODULE).pdf + @mkpdf_options=""; \ + gtkdoc-mkpdf 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + mkpdf_options="$$mkpdf_options --verbose"; \ + fi; \ + fi; \ + if test "x$(HTML_IMAGES)" != "x"; then \ + for img in $(HTML_IMAGES); do \ + part=`dirname $$img`; \ + echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \ + if test $$? != 0; then \ + mkpdf_options="$$mkpdf_options --imgdir=$$part"; \ + fi; \ + done; \ + fi; \ + gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS) + @touch pdf-build.stamp + +############## + +clean-local: + @rm -f *~ *.bak + @rm -rf .libs + +distclean-local: + @rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \ + $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ + rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \ + rm -rf tmpl; \ + fi + +maintainer-clean-local: clean + @rm -rf xml html + +install-data-local: + @installfiles=`echo $(builddir)/html/*`; \ + if test "$$installfiles" = '$(builddir)/html/*'; \ + then echo 1>&2 'Nothing to install' ; \ + else \ + if test -n "$(DOC_MODULE_VERSION)"; then \ + installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \ + else \ + installdir="$(DESTDIR)$(TARGET_DIR)"; \ + fi; \ + $(mkinstalldirs) $${installdir} ; \ + for i in $$installfiles; do \ + echo ' $(INSTALL_DATA) '$$i ; \ + $(INSTALL_DATA) $$i $${installdir}; \ + done; \ + if test -n "$(DOC_MODULE_VERSION)"; then \ + mv -f $${installdir}/$(DOC_MODULE).devhelp2 \ + $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \ + fi; \ + $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \ + fi + +uninstall-local: + @if test -n "$(DOC_MODULE_VERSION)"; then \ + installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \ + else \ + installdir="$(DESTDIR)$(TARGET_DIR)"; \ + fi; \ + rm -rf $${installdir} + +# +# Require gtk-doc when making dist +# +@ENABLE_GTK_DOC_TRUE@dist-check-gtkdoc: +@ENABLE_GTK_DOC_FALSE@dist-check-gtkdoc: +@ENABLE_GTK_DOC_FALSE@ @echo "*** gtk-doc must be installed and enabled in order to make dist" +@ENABLE_GTK_DOC_FALSE@ @false + +dist-hook: dist-check-gtkdoc dist-hook-local + @mkdir $(distdir)/tmpl + @mkdir $(distdir)/html + @-cp ./tmpl/*.sgml $(distdir)/tmpl + @cp ./html/* $(distdir)/html + @-cp ./$(DOC_MODULE).pdf $(distdir)/ + @-cp ./$(DOC_MODULE).types $(distdir)/ + @-cp ./$(DOC_MODULE)-sections.txt $(distdir)/ + @cd $(distdir) && rm -f $(DISTCLEANFILES) + @$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html + +.PHONY : dist-hook-local docs + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/docs/reference/libcaja-extension/html/ch01.html b/docs/reference/libcaja-extension/html/ch01.html new file mode 100644 index 00000000..8e90e1fd --- /dev/null +++ b/docs/reference/libcaja-extension/html/ch01.html @@ -0,0 +1,63 @@ + + + + +Extension Interfaces + + + + + + + + + + + + + + + + +
+

+Extension Interfaces

+
+
+caja-column-provider +
+
+CajaColumn +
+
+caja-extension-types +
+
+caja-file-info +
+
+caja-info-provider +
+
+caja-location-widget-provider +
+
+caja-menu-provider +
+
+CajaMenuItem +
+
+caja-property-page-provider +
+
+CajaPropertyPage +
+
+<xi:include></xi:include> +
+
+
+ Generated by GTK-Doc V1.15
+ + \ No newline at end of file diff --git a/docs/reference/libcaja-extension/html/home.png b/docs/reference/libcaja-extension/html/home.png new file mode 100644 index 00000000..17003611 Binary files /dev/null and b/docs/reference/libcaja-extension/html/home.png differ diff --git a/docs/reference/libcaja-extension/html/index.html b/docs/reference/libcaja-extension/html/index.html new file mode 100644 index 00000000..6d4ef0bf --- /dev/null +++ b/docs/reference/libcaja-extension/html/index.html @@ -0,0 +1,66 @@ + + + + +Caja Extension Reference Manual + + + + + + + +
+
+
+
+

For Caja-Extension 3:0:2 +

+
+
+
+
+
I. API Reference
+
+
Extension Interfaces
+
+
+caja-column-provider +
+
+CajaColumn +
+
+caja-extension-types +
+
+caja-file-info +
+
+caja-info-provider +
+
+caja-location-widget-provider +
+
+caja-menu-provider +
+
+CajaMenuItem +
+
+caja-property-page-provider +
+
+CajaPropertyPage +
+
+
+
Index
+
+
+
+
+ Generated by GTK-Doc V1.15
+ + \ No newline at end of file diff --git a/docs/reference/libcaja-extension/html/index.sgml b/docs/reference/libcaja-extension/html/index.sgml new file mode 100644 index 00000000..aa9b75e4 --- /dev/null +++ b/docs/reference/libcaja-extension/html/index.sgml @@ -0,0 +1,170 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/reference/libcaja-extension/html/ix01.html b/docs/reference/libcaja-extension/html/ix01.html new file mode 100644 index 00000000..289c1018 --- /dev/null +++ b/docs/reference/libcaja-extension/html/ix01.html @@ -0,0 +1,224 @@ + + + + +Index + + + + + + + + + + + + + + + +
+

+Index

+
+

N

+
+
CajaColumn, CajaColumn +
+
CajaColumn:attribute, The "attribute" property +
+
CajaColumn:attribute-q, The "attribute-q" property +
+
CajaColumn:description, The "description" property +
+
CajaColumn:label, The "label" property +
+
CajaColumn:name, The "name" property +
+
CajaColumn:xalign, The "xalign" property +
+
CajaColumnDetails, CajaColumnDetails +
+
CajaColumnProvider, CajaColumnProvider +
+
CajaColumnProviderIface, CajaColumnProviderIface +
+
CajaFile, CajaFile +
+
CajaFileInfo, caja-file-info +
+
CajaFileInfoIface, CajaFileInfoIface +
+
CajaInfoProvider, CajaInfoProvider +
+
CajaInfoProviderIface, CajaInfoProviderIface +
+
CajaInfoProviderUpdateComplete, CajaInfoProviderUpdateComplete () +
+
CajaLocationWidgetProvider, CajaLocationWidgetProvider +
+
CajaLocationWidgetProviderIface, CajaLocationWidgetProviderIface +
+
CajaMenu, CajaMenu +
+
CajaMenuItem, CajaMenuItem +
+
CajaMenuItem::activate, The "activate" signal +
+
CajaMenuItem:icon, The "icon" property +
+
CajaMenuItem:label, The "label" property +
+
CajaMenuItem:menu, The "menu" property +
+
CajaMenuItem:name, The "name" property +
+
CajaMenuItem:priority, The "priority" property +
+
CajaMenuItem:sensitive, The "sensitive" property +
+
CajaMenuItem:tip, The "tip" property +
+
CajaMenuItemDetails, CajaMenuItemDetails +
+
CajaMenuPrivate, CajaMenuPrivate +
+
CajaMenuProvider, CajaMenuProvider +
+
CajaMenuProvider::items-updated, The "items-updated" signal +
+
CajaMenuProviderIface, CajaMenuProviderIface +
+
CajaOperationHandle, CajaOperationHandle +
+
CajaOperationResult, enum CajaOperationResult +
+
CajaPropertyPage, CajaPropertyPage +
+
CajaPropertyPage:label, The "label" property +
+
CajaPropertyPage:name, The "name" property +
+
CajaPropertyPage:page, The "page" property +
+
CajaPropertyPageDetails, CajaPropertyPageDetails +
+
CajaPropertyPageProvider, CajaPropertyPageProvider +
+
CajaPropertyPageProviderIface, CajaPropertyPageProviderIface +
+
caja_column_new, caja_column_new () +
+
caja_column_provider_get_columns, caja_column_provider_get_columns () +
+
CAJA_FILE_DEFINED, CAJA_FILE_DEFINED +
+
caja_file_info_add_emblem, caja_file_info_add_emblem () +
+
caja_file_info_add_string_attribute, caja_file_info_add_string_attribute () +
+
caja_file_info_can_write, caja_file_info_can_write () +
+
caja_file_info_get_activation_uri, caja_file_info_get_activation_uri () +
+
caja_file_info_get_file_type, caja_file_info_get_file_type () +
+
caja_file_info_get_location, caja_file_info_get_location () +
+
caja_file_info_get_mime_type, caja_file_info_get_mime_type () +
+
caja_file_info_get_mount, caja_file_info_get_mount () +
+
caja_file_info_get_name, caja_file_info_get_name () +
+
caja_file_info_get_parent_info, caja_file_info_get_parent_info () +
+
caja_file_info_get_parent_location, caja_file_info_get_parent_location () +
+
caja_file_info_get_parent_uri, caja_file_info_get_parent_uri () +
+
caja_file_info_get_string_attribute, caja_file_info_get_string_attribute () +
+
caja_file_info_get_uri, caja_file_info_get_uri () +
+
caja_file_info_get_uri_scheme, caja_file_info_get_uri_scheme () +
+
caja_file_info_invalidate_extension_info, caja_file_info_invalidate_extension_info () +
+
caja_file_info_is_directory, caja_file_info_is_directory () +
+
caja_file_info_is_gone, caja_file_info_is_gone () +
+
caja_file_info_is_mime_type, caja_file_info_is_mime_type () +
+
caja_file_info_list_copy, caja_file_info_list_copy () +
+
caja_file_info_list_free, caja_file_info_list_free () +
+
caja_info_provider_cancel_update, caja_info_provider_cancel_update () +
+
caja_info_provider_update_complete_invoke, caja_info_provider_update_complete_invoke () +
+
caja_info_provider_update_file_info, caja_info_provider_update_file_info () +
+
caja_location_widget_provider_get_widget, caja_location_widget_provider_get_widget () +
+
caja_menu_append_item, caja_menu_append_item () +
+
caja_menu_get_items, caja_menu_get_items () +
+
CAJA_MENU_IS_ITEM, CAJA_MENU_IS_ITEM() +
+
CAJA_MENU_IS_ITEM_CLASS, CAJA_MENU_IS_ITEM_CLASS() +
+
CAJA_MENU_ITEM, CAJA_MENU_ITEM() +
+
caja_menu_item_activate, caja_menu_item_activate () +
+
CAJA_MENU_ITEM_CLASS, CAJA_MENU_ITEM_CLASS() +
+
CAJA_MENU_ITEM_GET_CLASS, CAJA_MENU_ITEM_GET_CLASS() +
+
caja_menu_item_get_type, caja_menu_item_get_type () +
+
caja_menu_item_list_free, caja_menu_item_list_free () +
+
caja_menu_item_new, caja_menu_item_new () +
+
caja_menu_item_set_submenu, caja_menu_item_set_submenu () +
+
caja_menu_new, caja_menu_new () +
+
caja_menu_provider_emit_items_updated_signal, caja_menu_provider_emit_items_updated_signal () +
+
caja_menu_provider_get_background_items, caja_menu_provider_get_background_items () +
+
caja_menu_provider_get_file_items, caja_menu_provider_get_file_items () +
+
caja_menu_provider_get_toolbar_items, caja_menu_provider_get_toolbar_items () +
+
caja_module_initialize, caja_module_initialize () +
+
caja_module_list_types, caja_module_list_types () +
+
caja_module_shutdown, caja_module_shutdown () +
+
caja_operation_result_get_type, caja_operation_result_get_type () +
+
caja_property_page_new, caja_property_page_new () +
+
caja_property_page_provider_get_pages, caja_property_page_provider_get_pages () +
+
CAJA_TYPE_MENU_ITEM, CAJA_TYPE_MENU_ITEM +
+
CAJA_TYPE_OPERATION_RESULT, CAJA_TYPE_OPERATION_RESULT +
+
+
+
+
+
+ Generated by GTK-Doc V1.15
+ + \ No newline at end of file diff --git a/docs/reference/libcaja-extension/html/left.png b/docs/reference/libcaja-extension/html/left.png new file mode 100644 index 00000000..2d05b3d5 Binary files /dev/null and b/docs/reference/libcaja-extension/html/left.png differ diff --git a/docs/reference/libcaja-extension/html/libcaja-extension-caja-column-provider.html b/docs/reference/libcaja-extension/html/libcaja-extension-caja-column-provider.html new file mode 100644 index 00000000..d09fd267 --- /dev/null +++ b/docs/reference/libcaja-extension/html/libcaja-extension-caja-column-provider.html @@ -0,0 +1,117 @@ + + + + +caja-column-provider + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

caja-column-provider

+

caja-column-provider

+
+
+

Synopsis

+
                    CajaColumnProvider;
+                    CajaColumnProviderIface;
+GList *             caja_column_provider_get_columns
+                                                        (CajaColumnProvider *provider);
+
+
+
+

Object Hierarchy

+
+  GInterface
+   +----CajaColumnProvider
+
+
+
+

Prerequisites

+

+CajaColumnProvider requires + GObject.

+
+
+

Description

+

+

+
+
+

Details

+
+

CajaColumnProvider

+
typedef struct _CajaColumnProvider CajaColumnProvider;
+

+

+
+
+
+

CajaColumnProviderIface

+
typedef struct {
+	GTypeInterface g_iface;
+
+	GList *(*get_columns) (CajaColumnProvider *provider);
+} CajaColumnProviderIface;
+
+

+

+
+
+
+

caja_column_provider_get_columns ()

+
GList *             caja_column_provider_get_columns
+                                                        (CajaColumnProvider *provider);
+

+

+
++ + + + + + + + + + +

provider :

 +

Returns :

 +
+
+
+
+
+
+ Generated by GTK-Doc V1.15
+ + diff --git a/docs/reference/libcaja-extension/html/libcaja-extension-caja-column.html b/docs/reference/libcaja-extension/html/libcaja-extension-caja-column.html new file mode 100644 index 00000000..53e19a1f --- /dev/null +++ b/docs/reference/libcaja-extension/html/libcaja-extension-caja-column.html @@ -0,0 +1,182 @@ + + + + +CajaColumn + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

CajaColumn

+

CajaColumn

+
+
+

Synopsis

+
                    CajaColumnDetails;
+                    CajaColumn;
+CajaColumn *    caja_column_new                 (const char *name,
+                                                         const char *attribute,
+                                                         const char *label,
+                                                         const char *description);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----CajaColumn
+
+
+
+

Properties

+
+  "attribute"                gchar*                : Read / Write
+  "attribute-q"              guint                 : Read
+  "description"              gchar*                : Read / Write
+  "label"                    gchar*                : Read / Write
+  "name"                     gchar*                : Read / Write / Construct Only
+  "xalign"                   gfloat                : Read / Write
+
+
+
+

Description

+

+

+
+
+

Details

+
+

CajaColumnDetails

+
typedef struct _CajaColumnDetails CajaColumnDetails;
+

+

+
+
+
+

CajaColumn

+
typedef struct _CajaColumn CajaColumn;
+

+

+
+
+
+

caja_column_new ()

+
CajaColumn *    caja_column_new                 (const char *name,
+                                                         const char *attribute,
+                                                         const char *label,
+                                                         const char *description);
+

+Creates a new column +

+
++ + + + + + + + + + + + + + + + + + + + + + +

name :

identifier of the column +

attribute :

the file attribute to be displayed in the column +

label :

the user-visible label for the column +

description :

a user-visible description of the column +

Returns :

 a newly created CajaColumn +
+
+
+
+

Property Details

+
+

The "attribute" property

+
  "attribute"                gchar*                : Read / Write
+

The attribute name to display.

+

Default value: NULL

+
+
+
+

The "attribute-q" property

+
  "attribute-q"              guint                 : Read
+

The attribute name to display, in quark form.

+

Default value: 0

+
+
+
+

The "description" property

+
  "description"              gchar*                : Read / Write
+

A user-visible description of the column.

+

Default value: NULL

+
+
+
+

The "label" property

+
  "label"                    gchar*                : Read / Write
+

Label to display in the column.

+

Default value: NULL

+
+
+
+

The "name" property

+
  "name"                     gchar*                : Read / Write / Construct Only
+

Name of the column.

+

Default value: NULL

+
+
+
+

The "xalign" property

+
  "xalign"                   gfloat                : Read / Write
+

The x-alignment of the column.

+

Allowed values: [0,1]

+

Default value: 0

+
+
+
+
+
+ Generated by GTK-Doc V1.15
+ + diff --git a/docs/reference/libcaja-extension/html/libcaja-extension-caja-extension-types.html b/docs/reference/libcaja-extension/html/libcaja-extension-caja-extension-types.html new file mode 100644 index 00000000..c01df269 --- /dev/null +++ b/docs/reference/libcaja-extension/html/libcaja-extension-caja-extension-types.html @@ -0,0 +1,158 @@ + + + + +caja-extension-types + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

caja-extension-types

+

caja-extension-types

+
+
+

Synopsis

+
#define             CAJA_TYPE_OPERATION_RESULT
+                    CajaOperationHandle;
+enum                CajaOperationResult;
+GType               caja_operation_result_get_type  (void);
+void                caja_module_initialize          (GTypeModule *module);
+void                caja_module_shutdown            (void);
+void                caja_module_list_types          (const GType **types,
+                                                         int *num_types);
+
+
+
+

Description

+

+

+
+
+

Details

+
+

CAJA_TYPE_OPERATION_RESULT

+
#define CAJA_TYPE_OPERATION_RESULT (caja_operation_result_get_type ())
+
+

+

+
+
+
+

CajaOperationHandle

+
typedef struct _CajaOperationHandle CajaOperationHandle;
+

+

+
+
+
+

enum CajaOperationResult

+
typedef enum {
+	/* Returned if the call succeeded, and the extension is done
+	 * with the request */
+	CAJA_OPERATION_COMPLETE,
+
+	/* Returned if the call failed */
+	CAJA_OPERATION_FAILED,
+
+	/* Returned if the extension has begun an async operation.
+	 * If this is returned, the extension must set the handle
+	 * parameter and call the callback closure when the
+	 * operation is complete. */
+	CAJA_OPERATION_IN_PROGRESS
+} CajaOperationResult;
+
+

+

+
+
+
+

caja_operation_result_get_type ()

+
GType               caja_operation_result_get_type  (void);
+

+

+
++ + + + +

Returns :

 +
+
+
+
+

caja_module_initialize ()

+
void                caja_module_initialize          (GTypeModule *module);
+

+

+
++ + + + +

module :

 +
+
+
+
+

caja_module_shutdown ()

+
void                caja_module_shutdown            (void);
+

+

+
+
+
+

caja_module_list_types ()

+
void                caja_module_list_types          (const GType **types,
+                                                         int *num_types);
+

+

+
++ + + + + + + + + + +

types :

 +

num_types :

 +
+
+
+
+
+
+ Generated by GTK-Doc V1.15
+ + diff --git a/docs/reference/libcaja-extension/html/libcaja-extension-caja-file-info.html b/docs/reference/libcaja-extension/html/libcaja-extension-caja-file-info.html new file mode 100644 index 00000000..38398bab --- /dev/null +++ b/docs/reference/libcaja-extension/html/libcaja-extension-caja-file-info.html @@ -0,0 +1,643 @@ + + + + +caja-file-info + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

caja-file-info

+

caja-file-info

+
+
+

Synopsis

+
#define             CAJA_FILE_DEFINED
+typedef             CajaFile;
+typedef             CajaFileInfo;
+                    CajaFileInfoIface;
+GList *             caja_file_info_list_copy        (GList *files);
+void                caja_file_info_list_free        (GList *files);
+gboolean            caja_file_info_is_gone          (CajaFileInfo *file);
+GFileType           caja_file_info_get_file_type    (CajaFileInfo *file);
+GFile *             caja_file_info_get_location     (CajaFileInfo *file);
+char *              caja_file_info_get_name         (CajaFileInfo *file);
+char *              caja_file_info_get_uri          (CajaFileInfo *file);
+char *              caja_file_info_get_activation_uri
+                                                        (CajaFileInfo *file);
+GFile *             caja_file_info_get_parent_location
+                                                        (CajaFileInfo *file);
+char *              caja_file_info_get_parent_uri   (CajaFileInfo *file);
+GMount *            caja_file_info_get_mount        (CajaFileInfo *file);
+char *              caja_file_info_get_uri_scheme   (CajaFileInfo *file);
+CajaFileInfo*   caja_file_info_get_parent_info  (CajaFileInfo *file);
+char *              caja_file_info_get_mime_type    (CajaFileInfo *file);
+gboolean            caja_file_info_is_mime_type     (CajaFileInfo *file,
+                                                         const char *mime_type);
+gboolean            caja_file_info_is_directory     (CajaFileInfo *file);
+gboolean            caja_file_info_can_write        (CajaFileInfo *file);
+void                caja_file_info_add_emblem       (CajaFileInfo *file,
+                                                         const char *emblem_name);
+char *              caja_file_info_get_string_attribute
+                                                        (CajaFileInfo *file,
+                                                         const char *attribute_name);
+void                caja_file_info_add_string_attribute
+                                                        (CajaFileInfo *file,
+                                                         const char *attribute_name,
+                                                         const char *value);
+void                caja_file_info_invalidate_extension_info
+                                                        (CajaFileInfo *file);
+
+
+
+

Object Hierarchy

+
+  GInterface
+   +----CajaFileInfo
+
+
+
+

Prerequisites

+

+CajaFileInfo requires + GObject.

+
+
+

Description

+

+

+
+
+

Details

+
+

CAJA_FILE_DEFINED

+
#define CAJA_FILE_DEFINED
+
+

+

+
+
+
+

CajaFile

+
typedef struct CajaFile          CajaFile;
+
+

+

+
+
+
+

CajaFileInfo

+
typedef CajaFile                  CajaFileInfo;
+
+

+

+
+
+
+

CajaFileInfoIface

+
typedef struct {
+	GTypeInterface g_iface;
+
+	gboolean          (*is_gone)              (CajaFileInfo *file);
+
+	char *            (*get_name)             (CajaFileInfo *file);
+	char *            (*get_uri)              (CajaFileInfo *file);
+	char *            (*get_parent_uri)       (CajaFileInfo *file);
+	char *            (*get_uri_scheme)       (CajaFileInfo *file);
+
+	char *            (*get_mime_type)        (CajaFileInfo *file);
+	gboolean          (*is_mime_type)         (CajaFileInfo *file,
+						   const char       *mime_Type);
+	gboolean          (*is_directory)         (CajaFileInfo *file);
+
+	void              (*add_emblem)           (CajaFileInfo *file,
+						   const char       *emblem_name);
+	char *            (*get_string_attribute) (CajaFileInfo *file,
+						   const char       *attribute_name);
+	void              (*add_string_attribute) (CajaFileInfo *file,
+						   const char       *attribute_name,
+						   const char       *value);
+	void              (*invalidate_extension_info) (CajaFileInfo *file);
+
+	char *            (*get_activation_uri)   (CajaFileInfo *file);
+
+	GFileType         (*get_file_type)        (CajaFileInfo *file);
+	GFile *           (*get_location)         (CajaFileInfo *file);
+	GFile *           (*get_parent_location)  (CajaFileInfo *file);
+	CajaFileInfo* (*get_parent_info)      (CajaFileInfo *file);
+	GMount *          (*get_mount)            (CajaFileInfo *file);
+	gboolean          (*can_write)            (CajaFileInfo *file);
+} CajaFileInfoIface;
+
+

+

+
+
+
+

caja_file_info_list_copy ()

+
GList *             caja_file_info_list_copy        (GList *files);
+

+

+
++ + + + + + + + + + +

files :

 +

Returns :

 +
+
+
+
+

caja_file_info_list_free ()

+
void                caja_file_info_list_free        (GList *files);
+

+

+
++ + + + +

files :

 +
+
+
+
+

caja_file_info_is_gone ()

+
gboolean            caja_file_info_is_gone          (CajaFileInfo *file);
+

+

+
++ + + + + + + + + + +

file :

 +

Returns :

 +
+
+
+
+

caja_file_info_get_file_type ()

+
GFileType           caja_file_info_get_file_type    (CajaFileInfo *file);
+

+

+
++ + + + + + + + + + +

file :

 +

Returns :

 +
+
+
+
+

caja_file_info_get_location ()

+
GFile *             caja_file_info_get_location     (CajaFileInfo *file);
+

+

+
++ + + + + + + + + + +

file :

 +

Returns :

 +
+
+
+
+

caja_file_info_get_name ()

+
char *              caja_file_info_get_name         (CajaFileInfo *file);
+

+

+
++ + + + + + + + + + +

file :

 +

Returns :

 +
+
+
+
+

caja_file_info_get_uri ()

+
char *              caja_file_info_get_uri          (CajaFileInfo *file);
+

+

+
++ + + + + + + + + + +

file :

 +

Returns :

 +
+
+
+
+

caja_file_info_get_activation_uri ()

+
char *              caja_file_info_get_activation_uri
+                                                        (CajaFileInfo *file);
+

+

+
++ + + + + + + + + + +

file :

 +

Returns :

 +
+
+
+
+

caja_file_info_get_parent_location ()

+
GFile *             caja_file_info_get_parent_location
+                                                        (CajaFileInfo *file);
+

+

+
++ + + + + + + + + + +

file :

 +

Returns :

 +
+
+
+
+

caja_file_info_get_parent_uri ()

+
char *              caja_file_info_get_parent_uri   (CajaFileInfo *file);
+

+

+
++ + + + + + + + + + +

file :

 +

Returns :

 +
+
+
+
+

caja_file_info_get_mount ()

+
GMount *            caja_file_info_get_mount        (CajaFileInfo *file);
+

+

+
++ + + + + + + + + + +

file :

 +

Returns :

 +
+
+
+
+

caja_file_info_get_uri_scheme ()

+
char *              caja_file_info_get_uri_scheme   (CajaFileInfo *file);
+

+

+
++ + + + + + + + + + +

file :

 +

Returns :

 +
+
+
+
+

caja_file_info_get_parent_info ()

+
CajaFileInfo*   caja_file_info_get_parent_info  (CajaFileInfo *file);
+

+

+
++ + + + + + + + + + +

file :

 +

Returns :

 +
+
+
+
+

caja_file_info_get_mime_type ()

+
char *              caja_file_info_get_mime_type    (CajaFileInfo *file);
+

+

+
++ + + + + + + + + + +

file :

 +

Returns :

 +
+
+
+
+

caja_file_info_is_mime_type ()

+
gboolean            caja_file_info_is_mime_type     (CajaFileInfo *file,
+                                                         const char *mime_type);
+

+

+
++ + + + + + + + + + + + + + +

file :

 +

mime_type :

 +

Returns :

 +
+
+
+
+

caja_file_info_is_directory ()

+
gboolean            caja_file_info_is_directory     (CajaFileInfo *file);
+

+

+
++ + + + + + + + + + +

file :

 +

Returns :

 +
+
+
+
+

caja_file_info_can_write ()

+
gboolean            caja_file_info_can_write        (CajaFileInfo *file);
+

+

+
++ + + + + + + + + + +

file :

 +

Returns :

 +
+
+
+
+

caja_file_info_add_emblem ()

+
void                caja_file_info_add_emblem       (CajaFileInfo *file,
+                                                         const char *emblem_name);
+

+

+
++ + + + + + + + + + +

file :

 +

emblem_name :

 +
+
+
+
+

caja_file_info_get_string_attribute ()

+
char *              caja_file_info_get_string_attribute
+                                                        (CajaFileInfo *file,
+                                                         const char *attribute_name);
+

+

+
++ + + + + + + + + + + + + + +

file :

 +

attribute_name :

 +

Returns :

 +
+
+
+
+

caja_file_info_add_string_attribute ()

+
void                caja_file_info_add_string_attribute
+                                                        (CajaFileInfo *file,
+                                                         const char *attribute_name,
+                                                         const char *value);
+

+

+
++ + + + + + + + + + + + + + +

file :

 +

attribute_name :

 +

value :

 +
+
+
+
+

caja_file_info_invalidate_extension_info ()

+
void                caja_file_info_invalidate_extension_info
+                                                        (CajaFileInfo *file);
+

+

+
++ + + + +

file :

 +
+
+
+
+
+
+ Generated by GTK-Doc V1.15
+ + diff --git a/docs/reference/libcaja-extension/html/libcaja-extension-caja-info-provider.html b/docs/reference/libcaja-extension/html/libcaja-extension-caja-info-provider.html new file mode 100644 index 00000000..08fd10e2 --- /dev/null +++ b/docs/reference/libcaja-extension/html/libcaja-extension-caja-info-provider.html @@ -0,0 +1,252 @@ + + + + +caja-info-provider + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

caja-info-provider

+

caja-info-provider

+
+
+

Synopsis

+
                    CajaInfoProvider;
+                    CajaInfoProviderIface;
+void                (*CajaInfoProviderUpdateComplete)
+                                                        (CajaInfoProvider *provider,
+                                                         CajaOperationHandle *handle,
+                                                         CajaOperationResult result,
+                                                         gpointer user_data);
+CajaOperationResult  caja_info_provider_update_file_info
+                                                        (CajaInfoProvider *provider,
+                                                         CajaFileInfo *file,
+                                                         GClosure *update_complete,
+                                                         CajaOperationHandle **handle);
+void                caja_info_provider_cancel_update
+                                                        (CajaInfoProvider *provider,
+                                                         CajaOperationHandle *handle);
+void                caja_info_provider_update_complete_invoke
+                                                        (GClosure *update_complete,
+                                                         CajaInfoProvider *provider,
+                                                         CajaOperationHandle *handle,
+                                                         CajaOperationResult result);
+
+
+
+

Object Hierarchy

+
+  GInterface
+   +----CajaInfoProvider
+
+
+
+

Prerequisites

+

+CajaInfoProvider requires + GObject.

+
+
+

Description

+

+

+
+
+

Details

+
+

CajaInfoProvider

+
typedef struct _CajaInfoProvider CajaInfoProvider;
+

+

+
+
+
+

CajaInfoProviderIface

+
typedef struct {
+	GTypeInterface g_iface;
+
+	CajaOperationResult (*update_file_info) (CajaInfoProvider     *provider,
+						     CajaFileInfo         *file,
+						     GClosure                 *update_complete,
+						     CajaOperationHandle **handle);
+	void                    (*cancel_update)    (CajaInfoProvider     *provider,
+						     CajaOperationHandle  *handle);
+} CajaInfoProviderIface;
+
+

+

+
+
+
+

CajaInfoProviderUpdateComplete ()

+
void                (*CajaInfoProviderUpdateComplete)
+                                                        (CajaInfoProvider *provider,
+                                                         CajaOperationHandle *handle,
+                                                         CajaOperationResult result,
+                                                         gpointer user_data);
+

+

+
++ + + + + + + + + + + + + + + + + + +

provider :

 +

handle :

 +

result :

 +

user_data :

 +
+
+
+
+

caja_info_provider_update_file_info ()

+
CajaOperationResult  caja_info_provider_update_file_info
+                                                        (CajaInfoProvider *provider,
+                                                         CajaFileInfo *file,
+                                                         GClosure *update_complete,
+                                                         CajaOperationHandle **handle);
+

+

+
++ + + + + + + + + + + + + + + + + + + + + + +

provider :

 +

file :

 +

update_complete :

 +

handle :

 +

Returns :

 +
+
+
+
+

caja_info_provider_cancel_update ()

+
void                caja_info_provider_cancel_update
+                                                        (CajaInfoProvider *provider,
+                                                         CajaOperationHandle *handle);
+

+

+
++ + + + + + + + + + +

provider :

 +

handle :

 +
+
+
+
+

caja_info_provider_update_complete_invoke ()

+
void                caja_info_provider_update_complete_invoke
+                                                        (GClosure *update_complete,
+                                                         CajaInfoProvider *provider,
+                                                         CajaOperationHandle *handle,
+                                                         CajaOperationResult result);
+

+

+
++ + + + + + + + + + + + + + + + + + +

update_complete :

 +

provider :

 +

handle :

 +

result :

 +
+
+
+
+
+
+ Generated by GTK-Doc V1.15
+ + diff --git a/docs/reference/libcaja-extension/html/libcaja-extension-caja-location-widget-provider.html b/docs/reference/libcaja-extension/html/libcaja-extension-caja-location-widget-provider.html new file mode 100644 index 00000000..975bd3a5 --- /dev/null +++ b/docs/reference/libcaja-extension/html/libcaja-extension-caja-location-widget-provider.html @@ -0,0 +1,133 @@ + + + + +caja-location-widget-provider + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

caja-location-widget-provider

+

caja-location-widget-provider

+
+
+

Synopsis

+
                    CajaLocationWidgetProvider;
+                    CajaLocationWidgetProviderIface;
+GtkWidget *         caja_location_widget_provider_get_widget
+                                                        (CajaLocationWidgetProvider *provider,
+                                                         const char *uri,
+                                                         GtkWidget *window);
+
+
+
+

Object Hierarchy

+
+  GInterface
+   +----CajaLocationWidgetProvider
+
+
+
+

Prerequisites

+

+CajaLocationWidgetProvider requires + GObject.

+
+
+

Description

+

+

+
+
+

Details

+
+

CajaLocationWidgetProvider

+
typedef struct _CajaLocationWidgetProvider CajaLocationWidgetProvider;
+

+

+
+
+
+

CajaLocationWidgetProviderIface

+
typedef struct {
+	GTypeInterface g_iface;
+
+	GtkWidget * (*get_widget) (CajaLocationWidgetProvider *provider,
+				   const char                     *uri,
+				   GtkWidget                      *window);
+} CajaLocationWidgetProviderIface;
+
+

+

+
+
+
+

caja_location_widget_provider_get_widget ()

+
GtkWidget *         caja_location_widget_provider_get_widget
+                                                        (CajaLocationWidgetProvider *provider,
+                                                         const char *uri,
+                                                         GtkWidget *window);
+

+

+
++ + + + + + + + + + + + + + + + + + +

provider :

 +

uri :

 +

window :

 +

Returns :

 +
+
+
+
+
+
+ Generated by GTK-Doc V1.15
+ + diff --git a/docs/reference/libcaja-extension/html/libcaja-extension-caja-menu-provider.html b/docs/reference/libcaja-extension/html/libcaja-extension-caja-menu-provider.html new file mode 100644 index 00000000..bb151c71 --- /dev/null +++ b/docs/reference/libcaja-extension/html/libcaja-extension-caja-menu-provider.html @@ -0,0 +1,267 @@ + + + + +caja-menu-provider + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

caja-menu-provider

+

caja-menu-provider

+
+
+

Synopsis

+
                    CajaMenuProvider;
+                    CajaMenuProviderIface;
+GList *             caja_menu_provider_get_file_items
+                                                        (CajaMenuProvider *provider,
+                                                         GtkWidget *window,
+                                                         GList *files);
+GList *             caja_menu_provider_get_background_items
+                                                        (CajaMenuProvider *provider,
+                                                         GtkWidget *window,
+                                                         CajaFileInfo *current_folder);
+GList *             caja_menu_provider_get_toolbar_items
+                                                        (CajaMenuProvider *provider,
+                                                         GtkWidget *window,
+                                                         CajaFileInfo *current_folder);
+void                caja_menu_provider_emit_items_updated_signal
+                                                        (CajaMenuProvider *provider);
+
+
+
+

Object Hierarchy

+
+  GInterface
+   +----CajaMenuProvider
+
+
+
+

Prerequisites

+

+CajaMenuProvider requires + GObject.

+
+
+

Signals

+
+  "items-updated"                                  : Run Last
+
+
+
+

Description

+

+

+
+
+

Details

+
+

CajaMenuProvider

+
typedef struct _CajaMenuProvider CajaMenuProvider;
+

+

+
+
+
+

CajaMenuProviderIface

+
typedef struct {
+	GTypeInterface g_iface;
+
+	GList *(*get_file_items)       (CajaMenuProvider *provider,
+					GtkWidget            *window,
+					GList                *files);
+	GList *(*get_background_items) (CajaMenuProvider *provider,
+					GtkWidget            *window,
+					CajaFileInfo     *current_folder);
+	GList *(*get_toolbar_items)    (CajaMenuProvider *provider,
+					GtkWidget            *window,
+				        CajaFileInfo     *current_folder);
+} CajaMenuProviderIface;
+
+

+

+
+
+
+

caja_menu_provider_get_file_items ()

+
GList *             caja_menu_provider_get_file_items
+                                                        (CajaMenuProvider *provider,
+                                                         GtkWidget *window,
+                                                         GList *files);
+

+

+
++ + + + + + + + + + + + + + + + + + +

provider :

 +

window :

 +

files :

 +

Returns :

 +
+
+
+
+

caja_menu_provider_get_background_items ()

+
GList *             caja_menu_provider_get_background_items
+                                                        (CajaMenuProvider *provider,
+                                                         GtkWidget *window,
+                                                         CajaFileInfo *current_folder);
+

+

+
++ + + + + + + + + + + + + + + + + + +

provider :

 +

window :

 +

current_folder :

 +

Returns :

 +
+
+
+
+

caja_menu_provider_get_toolbar_items ()

+
GList *             caja_menu_provider_get_toolbar_items
+                                                        (CajaMenuProvider *provider,
+                                                         GtkWidget *window,
+                                                         CajaFileInfo *current_folder);
+

+

+
++ + + + + + + + + + + + + + + + + + +

provider :

 +

window :

 +

current_folder :

 +

Returns :

 +
+
+
+
+

caja_menu_provider_emit_items_updated_signal ()

+
void                caja_menu_provider_emit_items_updated_signal
+                                                        (CajaMenuProvider *provider);
+

+

+
++ + + + +

provider :

 +
+
+
+
+

Signal Details

+
+

The "items-updated" signal

+
void                user_function                      (CajaMenuProvider *cajamenuprovider,
+                                                        gpointer              user_data)                 : Run Last
+

+

+
++ + + + + + + + + + +

cajamenuprovider :

the object which received the signal. +

user_data :

user data set when the signal handler was connected.
+
+
+
+
+
+ Generated by GTK-Doc V1.15
+ + diff --git a/docs/reference/libcaja-extension/html/libcaja-extension-caja-menu.html b/docs/reference/libcaja-extension/html/libcaja-extension-caja-menu.html new file mode 100644 index 00000000..d4cc454f --- /dev/null +++ b/docs/reference/libcaja-extension/html/libcaja-extension-caja-menu.html @@ -0,0 +1,473 @@ + + + + +CajaMenuItem + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

CajaMenuItem

+

CajaMenuItem

+
+
+

Synopsis

+
#define             CAJA_TYPE_MENU_ITEM
+#define             CAJA_MENU_ITEM                  (obj)
+#define             CAJA_MENU_ITEM_CLASS            (klass)
+#define             CAJA_MENU_IS_ITEM               (obj)
+#define             CAJA_MENU_IS_ITEM_CLASS         (klass)
+#define             CAJA_MENU_ITEM_GET_CLASS        (obj)
+                    CajaMenuPrivate;
+                    CajaMenuItemDetails;
+                    CajaMenu;
+                    CajaMenuItem;
+CajaMenu *      caja_menu_new                   (void);
+void                caja_menu_append_item           (CajaMenu *menu,
+                                                         CajaMenuItem *item);
+GList*              caja_menu_get_items             (CajaMenu *menu);
+void                caja_menu_item_list_free        (GList *item_list);
+GType               caja_menu_item_get_type         (void);
+CajaMenuItem *  caja_menu_item_new              (const char *name,
+                                                         const char *label,
+                                                         const char *tip,
+                                                         const char *icon);
+void                caja_menu_item_activate         (CajaMenuItem *item);
+void                caja_menu_item_set_submenu      (CajaMenuItem *item,
+                                                         CajaMenu *menu);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----CajaMenu
+
+
+  GObject
+   +----CajaMenuItem
+
+
+
+

Properties

+
+  "icon"                     gchar*                : Read / Write
+  "label"                    gchar*                : Read / Write
+  "menu"                     CajaMenu*         : Read / Write
+  "name"                     gchar*                : Read / Write / Construct Only
+  "priority"                 gboolean              : Read / Write
+  "sensitive"                gboolean              : Read / Write
+  "tip"                      gchar*                : Read / Write
+
+
+
+

Signals

+
+  "activate"                                       : Run Last
+
+
+
+

Description

+

+

+
+
+

Details

+
+

CAJA_TYPE_MENU_ITEM

+
#define CAJA_TYPE_MENU_ITEM            (caja_menu_item_get_type())
+
+

+

+
+
+
+

CAJA_MENU_ITEM()

+
#define CAJA_MENU_ITEM(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), CAJA_TYPE_MENU_ITEM, CajaMenuItem))
+
+

+

+
++ + + + +

obj :

 +
+
+
+
+

CAJA_MENU_ITEM_CLASS()

+
#define CAJA_MENU_ITEM_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), CAJA_TYPE_MENU_ITEM, CajaMenuItemClass))
+
+

+

+
++ + + + +

klass :

 +
+
+
+
+

CAJA_MENU_IS_ITEM()

+
#define CAJA_MENU_IS_ITEM(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CAJA_TYPE_MENU_ITEM))
+
+

+

+
++ + + + +

obj :

 +
+
+
+
+

CAJA_MENU_IS_ITEM_CLASS()

+
#define CAJA_MENU_IS_ITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), CAJA_TYPE_MENU_ITEM))
+
+

+

+
++ + + + +

klass :

 +
+
+
+
+

CAJA_MENU_ITEM_GET_CLASS()

+
#define CAJA_MENU_ITEM_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), CAJA_TYPE_MENU_ITEM, CajaMenuItemClass))
+
+

+

+
++ + + + +

obj :

 +
+
+
+
+

CajaMenuPrivate

+
typedef struct _CajaMenuPrivate CajaMenuPrivate;
+

+

+
+
+
+

CajaMenuItemDetails

+
typedef struct _CajaMenuItemDetails CajaMenuItemDetails;
+

+

+
+
+
+

CajaMenu

+
typedef struct _CajaMenu CajaMenu;
+

+

+
+
+
+

CajaMenuItem

+
typedef struct _CajaMenuItem CajaMenuItem;
+

+

+
+
+
+

caja_menu_new ()

+
CajaMenu *      caja_menu_new                   (void);
+

+

+
++ + + + +

Returns :

 +
+
+
+
+

caja_menu_append_item ()

+
void                caja_menu_append_item           (CajaMenu *menu,
+                                                         CajaMenuItem *item);
+

+

+
++ + + + + + + + + + +

menu :

 +

item :

 +
+
+
+
+

caja_menu_get_items ()

+
GList*              caja_menu_get_items             (CajaMenu *menu);
+

+

+
++ + + + + + + + + + +

menu :

 +

Returns :

 +
+
+
+
+

caja_menu_item_list_free ()

+
void                caja_menu_item_list_free        (GList *item_list);
+

+

+
++ + + + +

item_list :

 +
+
+
+
+

caja_menu_item_get_type ()

+
GType               caja_menu_item_get_type         (void);
+

+

+
++ + + + +

Returns :

 +
+
+
+
+

caja_menu_item_new ()

+
CajaMenuItem *  caja_menu_item_new              (const char *name,
+                                                         const char *label,
+                                                         const char *tip,
+                                                         const char *icon);
+

+Creates a new menu item that can be added to the toolbar or to a contextual menu. +

+
++ + + + + + + + + + + + + + + + + + + + + + +

name :

the identifier for the menu item +

label :

the user-visible label of the menu item +

tip :

the tooltip of the menu item +

icon :

the name of the icon to display in the menu item +

Returns :

 a newly create CajaMenuItem +
+
+
+
+

caja_menu_item_activate ()

+
void                caja_menu_item_activate         (CajaMenuItem *item);
+

+emits the activate signal. +

+
++ + + + +

item :

pointer to a CajaMenuItem +
+
+
+
+

caja_menu_item_set_submenu ()

+
void                caja_menu_item_set_submenu      (CajaMenuItem *item,
+                                                         CajaMenu *menu);
+

+Attachs a menu to the given CajaMenuItem. +

+
++ + + + + + + + + + +

item :

pointer to a CajaMenuItem +

menu :

pointer to a CajaMenu to attach to the button +
+
+
+
+

Property Details

+
+

The "icon" property

+
  "icon"                     gchar*                : Read / Write
+

Name of the icon to display in the menu item.

+

Default value: NULL

+
+
+
+

The "label" property

+
  "label"                    gchar*                : Read / Write
+

Label to display to the user.

+

Default value: NULL

+
+
+
+

The "menu" property

+
  "menu"                     CajaMenu*         : Read / Write
+

The menu belonging to this item. May be null.

+
+
+
+

The "name" property

+
  "name"                     gchar*                : Read / Write / Construct Only
+

Name of the item.

+

Default value: NULL

+
+
+
+

The "priority" property

+
  "priority"                 gboolean              : Read / Write
+

Show priority text in toolbars.

+

Default value: TRUE

+
+
+
+

The "sensitive" property

+
  "sensitive"                gboolean              : Read / Write
+

Whether the menu item is sensitive.

+

Default value: TRUE

+
+
+
+

The "tip" property

+
  "tip"                      gchar*                : Read / Write
+

Tooltip for the menu item.

+

Default value: NULL

+
+
+
+

Signal Details

+
+

The "activate" signal

+
void                user_function                      (CajaMenuItem *cajamenuitem,
+                                                        gpointer          user_data)             : Run Last
+

+

+
++ + + + + + + + + + +

cajamenuitem :

the object which received the signal. +

user_data :

user data set when the signal handler was connected.
+
+
+
+
+
+ Generated by GTK-Doc V1.15
+ + diff --git a/docs/reference/libcaja-extension/html/libcaja-extension-caja-property-page-provider.html b/docs/reference/libcaja-extension/html/libcaja-extension-caja-property-page-provider.html new file mode 100644 index 00000000..1fc67986 --- /dev/null +++ b/docs/reference/libcaja-extension/html/libcaja-extension-caja-property-page-provider.html @@ -0,0 +1,131 @@ + + + + +caja-property-page-provider + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

caja-property-page-provider

+

caja-property-page-provider

+
+
+

Synopsis

+
                    CajaPropertyPageProvider;
+                    CajaPropertyPageProviderIface;
+GList *             caja_property_page_provider_get_pages
+                                                        (CajaPropertyPageProvider *provider,
+                                                         GList *files);
+
+
+
+

Object Hierarchy

+
+  GInterface
+   +----CajaPropertyPageProvider
+
+
+
+

Prerequisites

+

+CajaPropertyPageProvider requires + GObject.

+
+
+

Description

+

+

+
+
+

Details

+
+

CajaPropertyPageProvider

+
typedef struct _CajaPropertyPageProvider CajaPropertyPageProvider;
+

+

+
+
+
+

CajaPropertyPageProviderIface

+
typedef struct {
+	GTypeInterface g_iface;
+
+	GList *(*get_pages) (CajaPropertyPageProvider     *provider,
+			     GList                    *files);
+} CajaPropertyPageProviderIface;
+
+

+

+
+
+
+

caja_property_page_provider_get_pages ()

+
GList *             caja_property_page_provider_get_pages
+                                                        (CajaPropertyPageProvider *provider,
+                                                         GList *files);
+

+This function is called by Caja when it wants property page +items from the extension. +

+

+This function is called in the main thread before a property page +is shown, so it should return quickly. +

+
++ + + + + + + + + + + + + + +

provider :

a CajaPropertyPageProvider +

files :

a GList of CajaFileInfo +

Returns :

 A GList of allocated CajaPropertyPage items. +
+
+
+
+
+
+ Generated by GTK-Doc V1.15
+ + diff --git a/docs/reference/libcaja-extension/html/libcaja-extension-caja-property-page.html b/docs/reference/libcaja-extension/html/libcaja-extension-caja-property-page.html new file mode 100644 index 00000000..2e77850e --- /dev/null +++ b/docs/reference/libcaja-extension/html/libcaja-extension-caja-property-page.html @@ -0,0 +1,148 @@ + + + + +CajaPropertyPage + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

CajaPropertyPage

+

CajaPropertyPage

+
+
+

Synopsis

+
                    CajaPropertyPageDetails;
+                    CajaPropertyPage;
+CajaPropertyPage * caja_property_page_new       (const char *name,
+                                                         GtkWidget *label,
+                                                         GtkWidget *page);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----CajaPropertyPage
+
+
+
+

Properties

+
+  "label"                    GtkWidget*            : Read / Write
+  "name"                     gchar*                : Read / Write / Construct Only
+  "page"                     GtkWidget*            : Read / Write
+
+
+
+

Description

+

+

+
+
+

Details

+
+

CajaPropertyPageDetails

+
typedef struct _CajaPropertyPageDetails CajaPropertyPageDetails;
+

+

+
+
+
+

CajaPropertyPage

+
typedef struct _CajaPropertyPage CajaPropertyPage;
+

+

+
+
+
+

caja_property_page_new ()

+
CajaPropertyPage * caja_property_page_new       (const char *name,
+                                                         GtkWidget *label,
+                                                         GtkWidget *page);
+

+Creates a new CajaPropertyPage from page_widget. +

+
++ + + + + + + + + + + + + + + + + + +

name :

the identifier for the property page +

label :

the user-visible label of the property page +

page :

the property page to display +

Returns :

 a newly created CajaPropertyPage +
+
+
+
+

Property Details

+
+

The "label" property

+
  "label"                    GtkWidget*            : Read / Write
+

Label widget to display in the notebook tab.

+
+
+
+

The "name" property

+
  "name"                     gchar*                : Read / Write / Construct Only
+

Name of the page.

+

Default value: NULL

+
+
+
+

The "page" property

+
  "page"                     GtkWidget*            : Read / Write
+

Widget for the property page.

+
+
+
+
+
+ Generated by GTK-Doc V1.15
+ + diff --git a/docs/reference/libcaja-extension/html/libcaja-extension.devhelp b/docs/reference/libcaja-extension/html/libcaja-extension.devhelp new file mode 100644 index 00000000..21967518 --- /dev/null +++ b/docs/reference/libcaja-extension/html/libcaja-extension.devhelp @@ -0,0 +1,118 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/reference/libcaja-extension/html/libcaja-extension.devhelp2 b/docs/reference/libcaja-extension/html/libcaja-extension.devhelp2 new file mode 100644 index 00000000..1869631b --- /dev/null +++ b/docs/reference/libcaja-extension/html/libcaja-extension.devhelp2 @@ -0,0 +1,118 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/reference/libcaja-extension/html/pt01.html b/docs/reference/libcaja-extension/html/pt01.html new file mode 100644 index 00000000..2795740a --- /dev/null +++ b/docs/reference/libcaja-extension/html/pt01.html @@ -0,0 +1,68 @@ + + + + +Part I. API Reference + + + + + + + + + + + + + + + + +
+

+Part I. API Reference

+
+

Table of Contents

+
+
Extension Interfaces
+
+
+caja-column-provider +
+
+CajaColumn +
+
+caja-extension-types +
+
+caja-file-info +
+
+caja-info-provider +
+
+caja-location-widget-provider +
+
+caja-menu-provider +
+
+CajaMenuItem +
+
+caja-property-page-provider +
+
+CajaPropertyPage +
+
+
+
+
+
+
+ Generated by GTK-Doc V1.15
+ + \ No newline at end of file diff --git a/docs/reference/libcaja-extension/html/right.png b/docs/reference/libcaja-extension/html/right.png new file mode 100644 index 00000000..92832e3a Binary files /dev/null and b/docs/reference/libcaja-extension/html/right.png differ diff --git a/docs/reference/libcaja-extension/html/style.css b/docs/reference/libcaja-extension/html/style.css new file mode 100644 index 00000000..d544a2c2 --- /dev/null +++ b/docs/reference/libcaja-extension/html/style.css @@ -0,0 +1,265 @@ +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + border: solid 1px #d3d7cf; + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + background: #e6f3ff; + border: solid 1px #729fcf; + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +@media screen { + sup a.footnote + { + position: relative; + top: 0em ! important; + + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + position: relative; + padding-top:4.5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 3.2em; + padding-bottom: 20em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + z-index: 10; + } + .navigation a, .navigation a:visited + { + /* tango:scarlet red 3 */ + color: #a40000; + } + .navigation a:hover + { + /* tango:scarlet red 1 */ + color: #ef2929; + } + td.shortcuts + { + /* tango:scarlet red 1 */ + color: #ef2929; + font-size: 80%; + white-space: nowrap; + } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + /* tango:scarlet red 0/1 */ + background: #ffe6e6; + border: solid 1px #ef2929; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + +.navigation .title +{ + font-size: 200%; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +hr +{ + /* tango:aluminium 3 */ + color: #babdb6; + background: #babdb6; + border: none 0px; + height: 1px; + clear: both; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + border-color: #ffb04f; +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + border-color: #abf562; +} +.note, .warning +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; +} +.note h3, .warning h3 +{ + margin-top: 0.0em +} +.note p, .warning p +{ + margin-bottom: 0.0em +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +.annotation +{ + /* tango:aluminium 5 */ + color: #555753; + font-size: 80%; + font-weight: normal; +} + +/* code listings */ + +.listing_code .programlisting .cbracket { color: #a40000; } /* tango: scarlet red 3 */ +.listing_code .programlisting .comment { color: #a1a39d; } /* tango: aluminium 4 */ +.listing_code .programlisting .function { color: #000000; font-weight: bold; } +.listing_code .programlisting .function a { color: #11326b; font-weight: bold; } /* tango: sky blue 4 */ +.listing_code .programlisting .keyword { color: #4e9a06; } /* tango: chameleon 3 */ +.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ +.listing_code .programlisting .normal { color: #000000; } +.listing_code .programlisting .number { color: #75507b; } /* tango: plum 2 */ +.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ +.listing_code .programlisting .string { color: #c17d11; } /* tango: chocolate 2 */ +.listing_code .programlisting .type { color: #000000; } +.listing_code .programlisting .type a { color: #11326b; } /* tango: sky blue 4 */ +.listing_code .programlisting .symbol { color: #ce5c00; } /* tango: orange 3 */ + +.listing_frame { + /* tango:sky blue 1 */ + border: solid 1px #729fcf; + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; +} +.listing_lines pre, .listing_code pre { + margin: 0px; +} + diff --git a/docs/reference/libcaja-extension/html/up.png b/docs/reference/libcaja-extension/html/up.png new file mode 100644 index 00000000..85b3e2a2 Binary files /dev/null and b/docs/reference/libcaja-extension/html/up.png differ diff --git a/docs/reference/libcaja-extension/libcaja-extension-docs.xml b/docs/reference/libcaja-extension/libcaja-extension-docs.xml new file mode 100644 index 00000000..a09d9757 --- /dev/null +++ b/docs/reference/libcaja-extension/libcaja-extension-docs.xml @@ -0,0 +1,36 @@ + + +]> + + + + Caja Extension Reference Manual + For Caja-Extension &version; + + + + + API Reference + + + Extension Interfaces + + + + + + + + + + + + + + + + Index + + diff --git a/docs/reference/libcaja-extension/libcaja-extension-overrides.txt b/docs/reference/libcaja-extension/libcaja-extension-overrides.txt new file mode 100644 index 00000000..e69de29b diff --git a/docs/reference/libcaja-extension/libcaja-extension-sections.txt b/docs/reference/libcaja-extension/libcaja-extension-sections.txt new file mode 100644 index 00000000..9de8dbfe --- /dev/null +++ b/docs/reference/libcaja-extension/libcaja-extension-sections.txt @@ -0,0 +1,185 @@ +
+caja-location-widget-provider +CajaLocationWidgetProvider +CajaLocationWidgetProviderIface +caja_location_widget_provider_get_widget + +CAJA_LOCATION_WIDGET_PROVIDER +CAJA_IS_LOCATION_WIDGET_PROVIDER +CAJA_TYPE_LOCATION_WIDGET_PROVIDER +caja_location_widget_provider_get_type +CAJA_LOCATION_WIDGET_PROVIDER_GET_IFACE +
+ +
+caja-menu-provider +CajaMenuProvider +CajaMenuProviderIface +caja_menu_provider_get_file_items +caja_menu_provider_get_background_items +caja_menu_provider_get_toolbar_items +caja_menu_provider_emit_items_updated_signal + +CAJA_MENU_PROVIDER +CAJA_IS_MENU_PROVIDER +CAJA_TYPE_MENU_PROVIDER +caja_menu_provider_get_type +CAJA_MENU_PROVIDER_GET_IFACE +
+ +
+caja-menu +CAJA_TYPE_MENU_ITEM +CAJA_MENU_ITEM +CAJA_MENU_ITEM_CLASS +CAJA_MENU_IS_ITEM +CAJA_MENU_IS_ITEM_CLASS +CAJA_MENU_ITEM_GET_CLASS +CajaMenuPrivate +CajaMenuItemDetails +CajaMenu +CajaMenu +CajaMenuItem +CajaMenuItem +caja_menu_new +caja_menu_append_item +caja_menu_get_items +caja_menu_item_list_free +caja_menu_item_get_type +caja_menu_item_new +caja_menu_item_activate +caja_menu_item_set_submenu + +CAJA_MENU +CAJA_IS_MENU +CAJA_TYPE_MENU +caja_menu_get_type +CAJA_MENU_CLASS +CAJA_IS_MENU_CLASS +CAJA_MENU_GET_CLASS +
+ +
+caja-column-provider +CajaColumnProvider +CajaColumnProviderIface +caja_column_provider_get_columns + +CAJA_COLUMN_PROVIDER +CAJA_IS_COLUMN_PROVIDER +CAJA_TYPE_COLUMN_PROVIDER +caja_column_provider_get_type +CAJA_COLUMN_PROVIDER_GET_IFACE +
+ +
+caja-property-page-provider +CajaPropertyPageProvider +CajaPropertyPageProviderIface +caja_property_page_provider_get_pages + +CAJA_PROPERTY_PAGE_PROVIDER +CAJA_IS_PROPERTY_PAGE_PROVIDER +CAJA_TYPE_PROPERTY_PAGE_PROVIDER +caja_property_page_provider_get_type +CAJA_PROPERTY_PAGE_PROVIDER_GET_IFACE +
+ +
+caja-file-info +CAJA_FILE_DEFINED +CajaFile +CajaFileInfo +CajaFileInfoIface +caja_file_info_list_copy +caja_file_info_list_free +caja_file_info_is_gone +caja_file_info_get_file_type +caja_file_info_get_location +caja_file_info_get_name +caja_file_info_get_uri +caja_file_info_get_activation_uri +caja_file_info_get_parent_location +caja_file_info_get_parent_uri +caja_file_info_get_mount +caja_file_info_get_uri_scheme +caja_file_info_get_parent_info +caja_file_info_get_mime_type +caja_file_info_is_mime_type +caja_file_info_is_directory +caja_file_info_can_write +caja_file_info_add_emblem +caja_file_info_get_string_attribute +caja_file_info_add_string_attribute +caja_file_info_invalidate_extension_info + +CAJA_FILE_INFO +CAJA_IS_FILE_INFO +CAJA_TYPE_FILE_INFO +caja_file_info_get_type +CAJA_FILE_INFO_GET_IFACE +
+ +
+caja-column +CajaColumnDetails +CajaColumn +CajaColumn +caja_column_new + +CAJA_COLUMN +CAJA_INFO_IS_COLUMN +CAJA_TYPE_COLUMN +caja_column_get_type +CAJA_COLUMN_CLASS +CAJA_INFO_IS_COLUMN_CLASS +CAJA_COLUMN_GET_CLASS +
+ +
+caja-info-provider +CajaInfoProvider +CajaInfoProviderIface +CajaInfoProviderUpdateComplete +caja_info_provider_update_file_info +caja_info_provider_cancel_update +caja_info_provider_update_complete_invoke + +CAJA_INFO_PROVIDER +CAJA_IS_INFO_PROVIDER +CAJA_TYPE_INFO_PROVIDER +caja_info_provider_get_type +CAJA_INFO_PROVIDER_GET_IFACE +
+ +
+caja-property-page +CajaPropertyPageDetails +CajaPropertyPage +CajaPropertyPage +caja_property_page_new + +CAJA_PROPERTY_PAGE +CAJA_IS_PROPERTY_PAGE +CAJA_TYPE_PROPERTY_PAGE +caja_property_page_get_type +CAJA_PROPERTY_PAGE_CLASS +CAJA_IS_PROPERTY_PAGE_CLASS +CAJA_PROPERTY_PAGE_GET_CLASS +
+ +
+caja-extension-types +CAJA_TYPE_OPERATION_RESULT +CajaOperationHandle +CajaOperationResult +caja_operation_result_get_type +caja_module_initialize +caja_module_shutdown +caja_module_list_types +
+ +
+caja-menu-item +
+ diff --git a/docs/reference/libcaja-extension/libcaja-extension.types b/docs/reference/libcaja-extension/libcaja-extension.types new file mode 100644 index 00000000..2c52af5d --- /dev/null +++ b/docs/reference/libcaja-extension/libcaja-extension.types @@ -0,0 +1,11 @@ +caja_property_page_provider_get_type +caja_location_widget_provider_get_type +caja_operation_result_get_type +caja_file_info_get_type +caja_property_page_get_type +caja_info_provider_get_type +caja_column_get_type +caja_column_provider_get_type +caja_menu_provider_get_type +caja_menu_get_type +caja_menu_item_get_type diff --git a/docs/reference/libcaja-extension/tmpl/caja-column-provider.sgml b/docs/reference/libcaja-extension/tmpl/caja-column-provider.sgml new file mode 100644 index 00000000..815284de --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-column-provider.sgml @@ -0,0 +1,45 @@ + +caja-column-provider + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@g_iface: +@get_columns: + + + + + + +@provider: +@Returns: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-column.sgml b/docs/reference/libcaja-extension/tmpl/caja-column.sgml new file mode 100644 index 00000000..a55b63ba --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-column.sgml @@ -0,0 +1,76 @@ + +CajaColumn + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@name: +@attribute: +@label: +@description: +@Returns: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-extension-types.sgml b/docs/reference/libcaja-extension/tmpl/caja-extension-types.sgml new file mode 100644 index 00000000..1fba8e67 --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-extension-types.sgml @@ -0,0 +1,78 @@ + +caja-extension-types + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@CAJA_OPERATION_COMPLETE: +@CAJA_OPERATION_FAILED: +@CAJA_OPERATION_IN_PROGRESS: + + + + + + +@void: +@Returns: + + + + + + + +@module: + + + + + + + +@void: + + + + + + + +@types: +@num_types: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-file-info.sgml b/docs/reference/libcaja-extension/tmpl/caja-file-info.sgml new file mode 100644 index 00000000..201be36a --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-file-info.sgml @@ -0,0 +1,257 @@ + +caja-file-info + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@g_iface: +@is_gone: +@get_name: +@get_uri: +@get_parent_uri: +@get_uri_scheme: +@get_mime_type: +@is_mime_type: +@is_directory: +@add_emblem: +@get_string_attribute: +@add_string_attribute: +@invalidate_extension_info: +@get_activation_uri: +@get_file_type: +@get_location: +@get_parent_location: +@get_parent_info: +@get_mount: +@can_write: + + + + + + +@files: +@Returns: + + + + + + + +@files: + + + + + + + +@file: +@Returns: + + + + + + + +@file: +@Returns: + + + + + + + +@file: +@Returns: + + + + + + + +@file: +@Returns: + + + + + + + +@file: +@Returns: + + + + + + + +@file: +@Returns: + + + + + + + +@file: +@Returns: + + + + + + + +@file: +@Returns: + + + + + + + +@file: +@Returns: + + + + + + + +@file: +@Returns: + + + + + + + +@file: +@Returns: + + + + + + + +@file: +@Returns: + + + + + + + +@file: +@mime_type: +@Returns: + + + + + + + +@file: +@Returns: + + + + + + + +@file: +@Returns: + + + + + + + +@file: +@emblem_name: + + + + + + + +@file: +@attribute_name: +@Returns: + + + + + + + +@file: +@attribute_name: +@value: + + + + + + + +@file: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-info-provider.sgml b/docs/reference/libcaja-extension/tmpl/caja-info-provider.sgml new file mode 100644 index 00000000..75b0e0f7 --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-info-provider.sgml @@ -0,0 +1,80 @@ + +caja-info-provider + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@g_iface: +@update_file_info: +@cancel_update: + + + + + + +@provider: +@handle: +@result: +@user_data: + + + + + + + +@provider: +@file: +@update_complete: +@handle: +@Returns: + + + + + + + +@provider: +@handle: + + + + + + + +@update_complete: +@provider: +@handle: +@result: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-location-widget-provider.sgml b/docs/reference/libcaja-extension/tmpl/caja-location-widget-provider.sgml new file mode 100644 index 00000000..d6effd30 --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-location-widget-provider.sgml @@ -0,0 +1,47 @@ + +caja-location-widget-provider + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@g_iface: +@get_widget: + + + + + + +@provider: +@uri: +@window: +@Returns: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-menu-item.sgml b/docs/reference/libcaja-extension/tmpl/caja-menu-item.sgml new file mode 100644 index 00000000..627f4a4a --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-menu-item.sgml @@ -0,0 +1,22 @@ + +caja-menu-item + + + + + + + + + + + + + + + + + + + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-menu-provider.sgml b/docs/reference/libcaja-extension/tmpl/caja-menu-provider.sgml new file mode 100644 index 00000000..9be2de5a --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-menu-provider.sgml @@ -0,0 +1,86 @@ + +caja-menu-provider + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@cajamenuprovider: the object which received the signal. + + + + + + +@g_iface: +@get_file_items: +@get_background_items: +@get_toolbar_items: + + + + + + +@provider: +@window: +@files: +@Returns: + + + + + + + +@provider: +@window: +@current_folder: +@Returns: + + + + + + + +@provider: +@window: +@current_folder: +@Returns: + + + + + + + +@provider: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-menu.sgml b/docs/reference/libcaja-extension/tmpl/caja-menu.sgml new file mode 100644 index 00000000..37187bc6 --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-menu.sgml @@ -0,0 +1,208 @@ + +CajaMenuItem + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + +@klass: + + + + + + + +@obj: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@cajamenuitem: the object which received the signal. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@void: +@Returns: + + + + + + + +@menu: +@item: + + + + + + + +@menu: +@Returns: + + + + + + + +@item_list: + + + + + + + +@void: +@Returns: + + + + + + + +@name: +@label: +@tip: +@icon: +@Returns: + + + + + + + +@item: + + + + + + + +@item: +@menu: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-property-page-provider.sgml b/docs/reference/libcaja-extension/tmpl/caja-property-page-provider.sgml new file mode 100644 index 00000000..a7df289b --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-property-page-provider.sgml @@ -0,0 +1,46 @@ + +caja-property-page-provider + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@g_iface: +@get_pages: + + + + + + +@provider: +@files: +@Returns: + + diff --git a/docs/reference/libcaja-extension/tmpl/caja-property-page.sgml b/docs/reference/libcaja-extension/tmpl/caja-property-page.sgml new file mode 100644 index 00000000..cc5753b2 --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/caja-property-page.sgml @@ -0,0 +1,60 @@ + +CajaPropertyPage + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@name: +@label: +@page: +@Returns: + + diff --git a/docs/reference/libcaja-extension/tmpl/libcaja-extension-unused.sgml b/docs/reference/libcaja-extension/tmpl/libcaja-extension-unused.sgml new file mode 100644 index 00000000..e69de29b diff --git a/docs/reference/libcaja-extension/version.xml.in b/docs/reference/libcaja-extension/version.xml.in new file mode 100644 index 00000000..d4c5173b --- /dev/null +++ b/docs/reference/libcaja-extension/version.xml.in @@ -0,0 +1 @@ +@CAJA_EXTENSION_VERSION_INFO@ diff --git a/docs/smoketests.html b/docs/smoketests.html new file mode 100644 index 00000000..80dd2dd4 --- /dev/null +++ b/docs/smoketests.html @@ -0,0 +1,555 @@ + + + + + + + + + + + + + +

Caja +Smoke Tests

+

The +Caja Smoke Tests are a minimal set of tests, to determine whether +a build is usable for testing, and to catch obvious regressions.

+



+

+

Views

+

Before +beginning this section, open a folder which contains at least one +MP3, image (GIF, JPEG or PNG), plain text, HTML, PDF, and RPM file. +(For those inside the Eazel firewall, these are in +/h/public/QE/smoketests.)

Also be sure to be in +single-click mode. (Preferences | Click Behavior | 'Active items with +single click')


+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

Test + #

+ 		+

Test

+ 		+

Test + Steps

+ 		+

Expected + Results

+
+

V-1

+ 		+

View + as Icon

+ 		+

1. + Select "View as Icons" from pop-up menu. +

+

2. + Zoom in to 400% and out to 25%, both via the pop-up menu, and via + +/- icons.

+


+

+ 		+


+

+
+

V-2

+ 		+

View + as List

+ 		+

1. + Select "View as List" from pop-up menu +

+

2. + Zoom in to 400% and out to 25%, and via +/- icons.

+ 		+


+

+
+

V-3

+ 		+

View + as Music

+ 		+

1. + Select "View as Music" from pop-up menu. +

+

2. + Play an MP3.

+ 		+


+

+
+

V-4

+ 		+

View + as Web Page

+ 		+

1. + Click on a file of type "HTML Document".

+ 		+


+

+
+

V-5

+ 		+

View + as Text

+ 		+

1. + Click on a file of type "plain text".

+ 		+


+

+
+

V-6

+ 		+

View + as Image

+ 		+

1. + Click on an image of type "JPEG image", "GIF + image", or "PNG image". (confirm)

+ 		+


+

+
+

V-7

+ 		+

View + as Hardware

+ 		+

1. + Type "hardware:" or "hardware:overview" into + the Location bar.

+ 		+


+

+
+

V-8

+ 		+

View + as PDF Document

+ 		+

1. + Click on a PDF file.

+ 		+


+

+
+

V-9

+ 		+

View + as Package

+ 		+

1. + Click on any Red Hat Package Manager file.

+ 		+


+

+
+



+

+

File +Operations

+

Before +beginning this section, change your Click Behavior (in Preferences) +to 'Active items with a double click'.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

Test + Number

+ 		+

Test

+ 		+

Test + Steps

+ 		+

Expected + Results

+
+

F-1

+ 		+

Rename + a file or folder

+ 		+

1. + Click on a file, and choose "Rename" from the File or + context menu. +

+

2. + Type in a new name

+ 		+


+

+
+

F-2

+ 		+

Duplicate + a file or folder

+ 		+

1. + Click on a file, and choose "Duplicate" from the File + or context menu.

+ 		+


+

+
+

F-3

+ 		+

Create + a link to a file or folder

+ 		+

1. + Click on a file, and choose "Create Link" from the File + or context menu.

+ 		+


+

+
+

F-4

+ 		+

Stretch + an icon

+ 		+

1. + Click on a file, and choose "Stretch Icon" from the + File or context menu. +

+

2. + Drag the icon by a corner, and enlarge or shrink it.

+ 		+


+

+
+



+

+

Desktop +Operations

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

Test + Number

+ 		+

Test

+ 		+

Test + Steps

+ 		+

Expected + Results

+
+

D-1

+ 		+

Empty + Trash

+ 		+

1. + Drag files or folders onto the Trash icon.

+

2. + Right-click on the Trash, and select "Empty Trash" + (alternatively, double-click on the trash can, and select "Empty + Trash" from the File menu.)

+


+

+ 		+


+

+
+

D-2

+ 		+

Drag + file to Desktop

+ 		+

1. + Drag a file from a Caja view window to the Desktop

+ 		+

File + should be moved to desktop.

+
+



Preferences/Customization

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

Test + Number

+ 		+

Test

+ 		+

Test + Steps

+ 		+

Expected + Results

+
+

P-1

+ 		+

Switch + Themes

+ 		+

1. + From a Caja window, choose "Caja Themes" from + the Edit menu. +

+

2. + Try each of the themes.

+ 		+


+

+
+

P-2

+ 		+

Switch + User Mode

+ 		+

1. + From a Caja window, try each of the three user modes.

+ 		+

In + Beginner mode: +

+
    +

  1. The + user mode menu's "Edit Beginner User Level" should + lead to a dialog with very minimal settings.

    +

  2. Dot + files (e.g. .bashrc) should not be displayed. +

    +

  3. The + "Special Flags" portion of the Show Properties + dialog's "Permissions" pane should be omitted. +

    +
+

In + Intermediate mode:

+
    +

  1. Dot + files (e.g. .bashrc) should not be displayed. +

    +

  2. The + "Special Flags" portion of the Show Properties + dialog's "Permissions" pane should be omitted. +

    +
+

In + Expert mode, none of the above user experience simplification + should occur.

+
+

P-3

+ 		+

Switch + Anti-aliasing mode

+ 		+

1. + While in Intermediate or Expert mode, choose "Preferences..." + From the user mode menu. +

+

2. + In the "Appearance" category, deselect the "Use + smoother (but slower) graphics" checkbox.

+ 		+

Text + and icons should no longer be anti-aliased.

+
+

P-4

+ 		+

Change + Background

+ 		+

1. + Choose "Backgrounds and Emblems" from the Edit menu. +

+

2. + Drag a few colors and backgrounds to the sidebar & main + window pane.

+ 		+


+

+
+



+

+

Maintained +by Josh Barrow for Caja +Quality Engineering, originally written by Eli +Goldberg; feedback welcome.
Adaptation and reuse for other +open source projects is freely permitted.
Last Updated: 9/28/2000

+ + \ No newline at end of file diff --git a/docs/state-machines.txt b/docs/state-machines.txt new file mode 100644 index 00000000..d89fcaec --- /dev/null +++ b/docs/state-machines.txt @@ -0,0 +1,77 @@ + +Proposal for the loading state machines + + +ViewFrame state machine + +States are: + + +E: Empty (the initial state right after construction) +A: Activating (waiting for component to be activated) +N: No load_location request (a view component has been loaded, but no load_location request has been sent yet) +W: Waiting (waiting for a response after a load request) +U: Underway (the component has responded and the load is assumed underway) +L: Loaded (the component has finished loading successfully) +F: Failed (there was a fatal error somewhere) + +X: this stimulus is guaranteed impossible in this state + + +Things I was unsure about: + +?2: Once a load has failed at some stage, should it be OK for Caja +to try to make further calls of any kind? + +Missing: + +1) "Component stops responding" stimulus. +2) Distinction of failure loading vs. crash of the component. + +Note: + +A "*" means that this is illegal but non-fatal, so we want to use g_warning. + + + State Transition Chart + + + Initial State + + | E | A | N | W | U | L | F | + ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| + successful load_client call | A | X | X | X | X | X | ?2 | + ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| + unsuccessful load_client call | F | X | X | X | X | X | ?2 | + ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| + successful activated_component call | X | N | X | X | X | X | ?2 | + ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| + unsuccessful activated_component call | X | F | X | X | X | X | ?2 | + ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| + stop activation | E | E | X | X | X | X | ?2 | + ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| + caja_view_frame_load_location call | X | F | W | W | W | W | ?2 | + ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| + open_location call from component | X | X | N* | U | U | L | X | + ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| + open_location_in_new_window | X | X | N* | U | U | L | X | + ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| + report_location_change | X | X | N* | U | U | U | X | +S ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| +t report_selection_change | X | X | N* | U | U | L | X | +i ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| +m report_status | X | X | N* | U | U | L | X | +u ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| +l report_load_underway | X | X | N* | U | U | U | X | +u ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| +s report_load_progress | X | X | N* | U | U | U | X | + ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| + report_load_complete | X | X | N* | L | L | L | X | + ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| + report_load_failed | X | X | N* | F | F | F | X | + ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| + set_title | X | X | N* | U | U | L | X | + ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| + user hits cancel on timer dialog | X | X | X | F | X | X | X | + ----------------------------------------|-----|-----|-----|-----|-----|-----|-----| + diff --git a/docs/style-guide.html b/docs/style-guide.html new file mode 100644 index 00000000..8215456d --- /dev/null +++ b/docs/style-guide.html @@ -0,0 +1,137 @@ + + + +Caja Coding Style Guide + + + + +

To make code written for Caja look and act in a predictable way, +we follow a set of guidelines that specify some details of how we write code. +To start, we follow all the guidelines outlined in the +MATE Programming Guidelines.

+ +

This document covers both things that are not mentioned in the MATE +Programming Guidelines and things that are mentioned there but need +to be re-emphasized because people don't follow them often enough.

+ +

I'm just getting started on this document. Feedback is welcome. +Eventually I'd like better organization and tons of examples.

+ +
+

- Darin

+
+ +
+ +

We use the most-recommended coding style from the MATE Programming +Guidelines. This means that we use the Linux kernel brace style with +8-character tabs (not the GNU brace style), we put spaces before +the parentheses that introduce function argument lists, we put the +braces that open the block for an if statement on the same line as the +if statement (part of Linux kernel brace style).

+ +

We prefer to use words rather than acronyms or abbreviations. This means that +we name classes with a prefix like Caja, not Ntl, for example. And we use variables +named result rather than retval or rv.

+ +

We strive to have a minimum number of local variables. This makes it +easier to move pieces of code around. For more on this, read +Refactoring.

+ +

We use type casts as little as possible. There are many places in GTK programming +where you have to cast to make the program work, but we do whatever we can +to avoid this. Also, we prefer to cast data pointers, rather than casting +function pointers, since there's so much more to get wrong with function +pointer casts.

+ +

We use typedefs from <glib.h> for things like guint, guchar and gpointer, +but not gint, gchar, or gdouble. Using these gives a false sense +of portability. In all three cases, using system calls like printf requires +knowing that these are the "real" int, char, and double, so there's no reason +to use a typedef that's non-standard unless it's a shorter name or clearer +in some way.

+ +

We avoid in-band signaling. This means that we avoid using special +values to indicate errors, for example. This can lead to subtle bugs when a valid +result is misinterpreted as an error, and can make it hard to tell if the code +handles errors or not.

+ +

We code for clarity first. Other concerns like efficiency are secondary. +Sometimes they become more important than clarity, but only once they are proven +to be a problem.

+ +

We use for loops when they make the code easier to read. The alternative +is usually to use a while loop. It's true that +"easy to read" is a subjective thing.

+ +

We declare local variables at the beginning of a block. C99 allows you +to declare variables anywhere in a function, but a lot of compilers still do not +support C99.

+ +

We do not initialize local variables in their declarations. C allows you +to initialize a local variable when declaring it. But no other code can run before +this, because the other statements in a function must be after all the declarations. +If there are lines of code initializing the variables in the declarations, it can +be harder to change the function around, since code must move down from the declaration +if other code needs to run after it. To avoid this, we just don't use the ability +to initialize the variable when it's declared.

+ +

We always use braces, even for one-statement "blocks". Our consensus is +to do things like this:

+ +
+
+if (list != NULL) {
+        g_warning ("the list isn't empty");
+}
+
+
+ +

Instead of this:

+ +
+
+if (list != NULL)
+        g_warning ("the list isn't empty");
+
+
+ +

This applies to all control structures: if, while, for, do.

+ +

We make each header "stand alone". Our concept with C header files is +that each one must be written so it can be included without including another file +first. To test that the header files we develop have this property, we always +include the corresponding header file first in each C source file. The only exception +is the include of <config.h>, which goes first. Here's an example:

+ +
+
+/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*-
+ *
+ * caja-icon-factory.c: Class for obtaining icons for files and other objects.
+ *
+ * Copyright (C) 1999, 2000 Red Hat Inc.
+ * Copyright (C) 1999, 2000 Eazel, Inc.
+ *
+ * License agreement goes here.
+ *
+ * Author: John Sullivan <sullivan@eazel.com>
+ */
+
+#include <config.h>
+#include "caja-icon-factory.h"
+
+#include <string.h>
+#include <stdio.h>
+Include statements for other header files go here.
+
+Other declarations and code go here.
+
+
+ +
+ + + + -- cgit v1.2.1