diff options
Diffstat (limited to 'docs')
59 files changed, 8125 insertions, 0 deletions
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 <n> 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 <[email protected]> for the +Debian GNU/Linux system (but may be used by others), based on a manpage by +Fernando Ribeiro <[email protected]>. 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 <n> 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 <[email protected]> for the +Debian GNU/Linux system (but may be used by others), based on a manpage by +Fernando Ribeiro <[email protected]>. diff --git a/docs/caja-internals.pdf b/docs/caja-internals.pdf Binary files differnew file mode 100644 index 00000000..8d321f1d --- /dev/null +++ b/docs/caja-internals.pdf diff --git a/docs/caja-internals.sxw b/docs/caja-internals.sxw Binary files differnew file mode 100644 index 00000000..23f687ba --- /dev/null +++ b/docs/caja-internals.sxw 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 <[email protected]> + +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 +<libmatevfs/mate-vfs-ops.h> 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 <n> 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 <[email protected]> and Dafydd +Harries <[email protected]> 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 Binary files differnew file mode 100644 index 00000000..d650ceae --- /dev/null +++ b/docs/load-states.dia 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 @@ +<html> + +<head> +<title>Eazel: Darin's Recommended Programming Books</title> +</head> + +<body> + +<p>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.</p> + +<p>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.</p> + +<p>If you buy books from Amazon.com using the links on this page, Darin will get a small kickback from Amazon.</p> + +<p>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.</p> + +<h2>C++ Reference Books</h2> + +<p>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.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0201889544/dianepattersonstA"><b><i>The C++ Programming Language, Third Edition</i></b></a>, +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 <a href="http://www.research.att.com/~bs/3rd.html">supporting materials</a> +for the book on the web, including the errata lists that enumerate all changes between printings.</p> + +<p><a name="Josuttis" href="http://www.amazon.com/exec/obidos/ASIN/0201379260/dianepattersonstA"><b><i>The C++ Standard Library</i></b></a>, +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 <a href="http://josuttis.com/libbook">supporting materials</a> on the web.</p> + +<h2>C++ Technique Books</h2> + +<p>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.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0201615622/dianepattersonstA"><b><i>Exceptional C++</i></b></a>, +Herb Sutter. This is a collection of material that was originally part of Herb's +<a href="http://www.peerdirect.com/resources"><i>Guru of the Week</i></a>. 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.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0201423391/dianepattersonstA"><b><i>Ruminations on C++</i></b></a>, +Andrew Koenig and Barbara Moo.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0201924889/dianepattersonstA"><b><i>Effective C++, Second Edition</i></b></a> +and <a href="http://www.amazon.com/exec/obidos/ASIN/020163371X/dianepattersonstA"><b><i>More Effective C++</i></b></a>, +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 +<a href="http://www.amazon.com/exec/obidos/ASIN/0201310155/dianepattersonstA">CD edition</a> +(there's a <a href="http://mox.eazel.com/mec">copy</a> 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 +<a href="http://cseng.aw.com/bookdetail.qry?ISBN=0-201-92488-9">the original</a> and +<a href="http://cseng.aw.com/bookdetail.qry?ISBN=0-201-63371-X">the second book</a></p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0201543303/dianepattersonstA"><b><i>The Design and Evolution of C++</i></b></a>, +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.</p> + +<h2>C++ Tutorial Books</h2> + +<p>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.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0201485184/dianepattersonstA"><b><i>Essential C++</i></b></a>, +Stanley Lippman. This tutorial is much more useful than the longer and more complete works, like +<a href="#Primer"><i>C++ Primer</i></a>. +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.</p> + +<h2>Gtk Books</h2> + +<p>OK, so I'm not an expert on Gtk yet. But I'm becoming one.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0735700788/dianepattersonstA"><b><i>Gtk+/Mate Application Development</i></b></a>, +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.</p> + +<h2>Programming Technique Books</h2> + +<p>These books are valuable because of the ideas in them, but are not specific to a particular programming language or toolkit.</p> + +<p><a name="Refactoring" href="http://www.amazon.com/exec/obidos/ASIN/0201485672/dianepattersonstA"><b><i>Refactoring</i></b></a>, +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++.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/020161586X/dianepattersonstA"><b><i>The Practice of Programming</i></b></a>, +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.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0201657880/dianepattersonstA"><b><i>Programming Pearls, Second Edition</i></b></a>, +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.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0201633612/dianepattersonstA"><b><i>Design Patterns</i></b></a>. +There's also a <a href="http://www.amazon.com/exec/obidos/ASIN/0201634988/dianepattersonstA">CD edition</a> +(there's a <a href="http://mox.eazel.com/dp">copy</a> of it on Rob's machine).</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0201350882/dianepattersonstA"><b><i>Algorithms in C++, Third Edition</i></b></a>, +Robert Sedgewick. The <a href="http://www.amazon.com/exec/obidos/ASIN/0201314525/dianepattersonstA">original version</a> is in C. +There's also an upcoming <a href="http://www.amazon.com/exec/obidos/ASIN/0201361205/dianepattersonstA">Java version</a>.</p> + +<h2>Books I Have Read, But Do Not Recommend</h2> + +<p>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.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0201498413/dianepattersonstA"><b><i>C Interfaces and Implementations</i></b></a>.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0201596415/dianepattersonstA"><b><i>C++ IOStreams Handbook</i></b></a>, +Steve Teale. <a href="Josuttis">Josuttis</a> covers streams better.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0201616416/dianepattersonstA"><b><i>Extreme Programming Explained</i></b></a>. +My love for <a href="Refactoring"><i>Refactoring</i></a> had me excited about this one, but it was a disappointment.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0201309564/dianepattersonstA"><b><i>Generic Programming and the STL</i></b></a>, +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 <a href="Josuttis">Josuttis</a> covers the STL better.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0131209655/dianepattersonstA"><b><i>Industrial Strength C++</i></b></a>.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0201834545/dianepattersonstA"><b><i>Inside the C++ Object Model</i></b></a>.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0201633620/dianepattersonstA"><b><i>Large-Scale C++ Software Design</i></b></a>, +John Lakos.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0130142697/dianepattersonstA"><b><i>Objects Unencapsulated: Java, Eiffel and C++??</i></b></a>. +This is a basically an "Eiffel is great, C++ sucks" book. Some interesting insights, but a lot of sloppy thinking.</p> + +<h2>Books That Need Review</h2> + +<p>This is a list of possibly important books that I haven't checked out yet.</p> + +<p><a name="Primer" href="http://www.amazon.com/exec/obidos/ASIN/0201824701/dianepattersonstA"><b><i>C++ Primer, Third Edition</i></b></a>, +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.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0201309939/dianepattersonstA"><b><i>C++ Primer Answer Book</i></b></a>. +I checked, and this answer book does go with the third edition of <i>C++ Primer</i>.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0201309599/dianepattersonstA"><b><i>Design Patterns and Contracts</i></b></a>.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0735700214/dianepattersonstA"><b><i>Developing Linux Applications with GTK+ and GDK</i></b></a>.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0764546406/dianepattersonstA"><b><i>Linux Mate/Gtk Programming Bible</i></b></a>.</p> + +<p><a href="http://www.amazon.com/exec/obidos/ASIN/0672318296/dianepattersonstA"><b><i>Sams Teach Yourself Gtk+ Programming in 21 Days</i></b></a>.</p> + +</body> + +</html> 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Extension Interfaces</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Caja Extension Reference Manual"> +<link rel="up" href="pt01.html" title="Part I. API Reference"> +<link rel="prev" href="pt01.html" title="Part I. API Reference"> +<link rel="next" href="libcaja-extension-caja-column-provider.html" title="caja-column-provider"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="pt01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="pt01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Caja Extension Reference Manual</th> +<td><a accesskey="n" href="libcaja-extension-caja-column-provider.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter" title="Extension Interfaces"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="id2829724"></a>Extension Interfaces</h2></div></div></div> +<div class="toc"><dl> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-column-provider.html">caja-column-provider</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-column.html">CajaColumn</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-extension-types.html">caja-extension-types</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-file-info.html">caja-file-info</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-info-provider.html">caja-info-provider</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-location-widget-provider.html">caja-location-widget-provider</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-menu-provider.html">caja-menu-provider</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-menu.html">CajaMenuItem</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-property-page-provider.html">caja-property-page-provider</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-property-page.html">CajaPropertyPage</a></span><span class="refpurpose"></span> +</dt> +</dl></div> +<span style="color: red"><xi:include></xi:include></span> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/libcaja-extension/html/home.png b/docs/reference/libcaja-extension/html/home.png Binary files differnew file mode 100644 index 00000000..17003611 --- /dev/null +++ b/docs/reference/libcaja-extension/html/home.png 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Caja Extension Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Caja Extension Reference Manual"> +<link rel="next" href="pt01.html" title="Part I. API Reference"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<div class="book" title="Caja Extension Reference Manual"> +<div class="titlepage"> +<div> +<div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">Caja Extension Reference Manual</p></th></tr></table></div> +<div><p class="releaseinfo">For Caja-Extension 3:0:2 +</p></div> +</div> +<hr> +</div> +<div class="toc"><dl> +<dt><span class="part"><a href="pt01.html">I. API Reference</a></span></dt> +<dd><dl> +<dt><span class="chapter"><a href="ch01.html">Extension Interfaces</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-column-provider.html">caja-column-provider</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-column.html">CajaColumn</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-extension-types.html">caja-extension-types</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-file-info.html">caja-file-info</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-info-provider.html">caja-info-provider</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-location-widget-provider.html">caja-location-widget-provider</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-menu-provider.html">caja-menu-provider</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-menu.html">CajaMenuItem</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-property-page-provider.html">caja-property-page-provider</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-property-page.html">CajaPropertyPage</a></span><span class="refpurpose"></span> +</dt> +</dl></dd> +</dl></dd> +<dt><span class="index"><a href="ix01.html">Index</a></span></dt> +</dl></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html>
\ 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 @@ +<ANCHOR id="libcaja-extension-caja-column-provider" href="libcaja-extension/libcaja-extension-caja-column-provider.html"> +<ANCHOR id="libcaja-extension-caja-column-provider.synopsis" href="libcaja-extension/libcaja-extension-caja-column-provider.html#libcaja-extension-caja-column-provider.synopsis"> +<ANCHOR id="CajaColumnProvider" href="libcaja-extension/libcaja-extension-caja-column-provider.html#CajaColumnProvider"> +<ANCHOR id="libcaja-extension-caja-column-provider.object-hierarchy" href="libcaja-extension/libcaja-extension-caja-column-provider.html#libcaja-extension-caja-column-provider.object-hierarchy"> +<ANCHOR id="libcaja-extension-caja-column-provider.prerequisites" href="libcaja-extension/libcaja-extension-caja-column-provider.html#libcaja-extension-caja-column-provider.prerequisites"> +<ANCHOR id="libcaja-extension-caja-column-provider.description" href="libcaja-extension/libcaja-extension-caja-column-provider.html#libcaja-extension-caja-column-provider.description"> +<ANCHOR id="libcaja-extension-caja-column-provider.details" href="libcaja-extension/libcaja-extension-caja-column-provider.html#libcaja-extension-caja-column-provider.details"> +<ANCHOR id="CajaColumnProvider-struct" href="libcaja-extension/libcaja-extension-caja-column-provider.html#CajaColumnProvider-struct"> +<ANCHOR id="CajaColumnProviderIface" href="libcaja-extension/libcaja-extension-caja-column-provider.html#CajaColumnProviderIface"> +<ANCHOR id="caja-column-provider-get-columns" href="libcaja-extension/libcaja-extension-caja-column-provider.html#caja-column-provider-get-columns"> +<ANCHOR id="libcaja-extension-caja-column" href="libcaja-extension/libcaja-extension-caja-column.html"> +<ANCHOR id="libcaja-extension-caja-column.synopsis" href="libcaja-extension/libcaja-extension-caja-column.html#libcaja-extension-caja-column.synopsis"> +<ANCHOR id="CajaColumn" href="libcaja-extension/libcaja-extension-caja-column.html#CajaColumn"> +<ANCHOR id="libcaja-extension-caja-column.object-hierarchy" href="libcaja-extension/libcaja-extension-caja-column.html#libcaja-extension-caja-column.object-hierarchy"> +<ANCHOR id="libcaja-extension-caja-column.properties" href="libcaja-extension/libcaja-extension-caja-column.html#libcaja-extension-caja-column.properties"> +<ANCHOR id="libcaja-extension-caja-column.description" href="libcaja-extension/libcaja-extension-caja-column.html#libcaja-extension-caja-column.description"> +<ANCHOR id="libcaja-extension-caja-column.details" href="libcaja-extension/libcaja-extension-caja-column.html#libcaja-extension-caja-column.details"> +<ANCHOR id="CajaColumnDetails" href="libcaja-extension/libcaja-extension-caja-column.html#CajaColumnDetails"> +<ANCHOR id="CajaColumn-struct" href="libcaja-extension/libcaja-extension-caja-column.html#CajaColumn-struct"> +<ANCHOR id="caja-column-new" href="libcaja-extension/libcaja-extension-caja-column.html#caja-column-new"> +<ANCHOR id="libcaja-extension-caja-column.property-details" href="libcaja-extension/libcaja-extension-caja-column.html#libcaja-extension-caja-column.property-details"> +<ANCHOR id="CajaColumn--attribute" href="libcaja-extension/libcaja-extension-caja-column.html#CajaColumn--attribute"> +<ANCHOR id="CajaColumn--attribute-q" href="libcaja-extension/libcaja-extension-caja-column.html#CajaColumn--attribute-q"> +<ANCHOR id="CajaColumn--description" href="libcaja-extension/libcaja-extension-caja-column.html#CajaColumn--description"> +<ANCHOR id="CajaColumn--label" href="libcaja-extension/libcaja-extension-caja-column.html#CajaColumn--label"> +<ANCHOR id="CajaColumn--name" href="libcaja-extension/libcaja-extension-caja-column.html#CajaColumn--name"> +<ANCHOR id="CajaColumn--xalign" href="libcaja-extension/libcaja-extension-caja-column.html#CajaColumn--xalign"> +<ANCHOR id="libcaja-extension-caja-extension-types" href="libcaja-extension/libcaja-extension-caja-extension-types.html"> +<ANCHOR id="libcaja-extension-caja-extension-types.synopsis" href="libcaja-extension/libcaja-extension-caja-extension-types.html#libcaja-extension-caja-extension-types.synopsis"> +<ANCHOR id="libcaja-extension-caja-extension-types.description" href="libcaja-extension/libcaja-extension-caja-extension-types.html#libcaja-extension-caja-extension-types.description"> +<ANCHOR id="libcaja-extension-caja-extension-types.details" href="libcaja-extension/libcaja-extension-caja-extension-types.html#libcaja-extension-caja-extension-types.details"> +<ANCHOR id="CAJA-TYPE-OPERATION-RESULT:CAPS" href="libcaja-extension/libcaja-extension-caja-extension-types.html#CAJA-TYPE-OPERATION-RESULT:CAPS"> +<ANCHOR id="CajaOperationHandle" href="libcaja-extension/libcaja-extension-caja-extension-types.html#CajaOperationHandle"> +<ANCHOR id="CajaOperationResult" href="libcaja-extension/libcaja-extension-caja-extension-types.html#CajaOperationResult"> +<ANCHOR id="caja-operation-result-get-type" href="libcaja-extension/libcaja-extension-caja-extension-types.html#caja-operation-result-get-type"> +<ANCHOR id="caja-module-initialize" href="libcaja-extension/libcaja-extension-caja-extension-types.html#caja-module-initialize"> +<ANCHOR id="caja-module-shutdown" href="libcaja-extension/libcaja-extension-caja-extension-types.html#caja-module-shutdown"> +<ANCHOR id="caja-module-list-types" href="libcaja-extension/libcaja-extension-caja-extension-types.html#caja-module-list-types"> +<ANCHOR id="libcaja-extension-caja-file-info" href="libcaja-extension/libcaja-extension-caja-file-info.html"> +<ANCHOR id="libcaja-extension-caja-file-info.synopsis" href="libcaja-extension/libcaja-extension-caja-file-info.html#libcaja-extension-caja-file-info.synopsis"> +<ANCHOR id="CajaFileInfo" href="libcaja-extension/libcaja-extension-caja-file-info.html#CajaFileInfo"> +<ANCHOR id="libcaja-extension-caja-file-info.object-hierarchy" href="libcaja-extension/libcaja-extension-caja-file-info.html#libcaja-extension-caja-file-info.object-hierarchy"> +<ANCHOR id="libcaja-extension-caja-file-info.prerequisites" href="libcaja-extension/libcaja-extension-caja-file-info.html#libcaja-extension-caja-file-info.prerequisites"> +<ANCHOR id="libcaja-extension-caja-file-info.description" href="libcaja-extension/libcaja-extension-caja-file-info.html#libcaja-extension-caja-file-info.description"> +<ANCHOR id="libcaja-extension-caja-file-info.details" href="libcaja-extension/libcaja-extension-caja-file-info.html#libcaja-extension-caja-file-info.details"> +<ANCHOR id="CAJA-FILE-DEFINED:CAPS" href="libcaja-extension/libcaja-extension-caja-file-info.html#CAJA-FILE-DEFINED:CAPS"> +<ANCHOR id="CajaFile" href="libcaja-extension/libcaja-extension-caja-file-info.html#CajaFile"> +<ANCHOR id="CajaFileInfo" href="libcaja-extension/libcaja-extension-caja-file-info.html#CajaFileInfo"> +<ANCHOR id="CajaFileInfoIface" href="libcaja-extension/libcaja-extension-caja-file-info.html#CajaFileInfoIface"> +<ANCHOR id="caja-file-info-list-copy" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-list-copy"> +<ANCHOR id="caja-file-info-list-free" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-list-free"> +<ANCHOR id="caja-file-info-is-gone" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-is-gone"> +<ANCHOR id="caja-file-info-get-file-type" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-get-file-type"> +<ANCHOR id="caja-file-info-get-location" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-get-location"> +<ANCHOR id="caja-file-info-get-name" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-get-name"> +<ANCHOR id="caja-file-info-get-uri" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-get-uri"> +<ANCHOR id="caja-file-info-get-activation-uri" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-get-activation-uri"> +<ANCHOR id="caja-file-info-get-parent-location" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-get-parent-location"> +<ANCHOR id="caja-file-info-get-parent-uri" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-get-parent-uri"> +<ANCHOR id="caja-file-info-get-mount" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-get-mount"> +<ANCHOR id="caja-file-info-get-uri-scheme" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-get-uri-scheme"> +<ANCHOR id="caja-file-info-get-parent-info" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-get-parent-info"> +<ANCHOR id="caja-file-info-get-mime-type" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-get-mime-type"> +<ANCHOR id="caja-file-info-is-mime-type" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-is-mime-type"> +<ANCHOR id="caja-file-info-is-directory" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-is-directory"> +<ANCHOR id="caja-file-info-can-write" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-can-write"> +<ANCHOR id="caja-file-info-add-emblem" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-add-emblem"> +<ANCHOR id="caja-file-info-get-string-attribute" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-get-string-attribute"> +<ANCHOR id="caja-file-info-add-string-attribute" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-add-string-attribute"> +<ANCHOR id="caja-file-info-invalidate-extension-info" href="libcaja-extension/libcaja-extension-caja-file-info.html#caja-file-info-invalidate-extension-info"> +<ANCHOR id="libcaja-extension-caja-info-provider" href="libcaja-extension/libcaja-extension-caja-info-provider.html"> +<ANCHOR id="libcaja-extension-caja-info-provider.synopsis" href="libcaja-extension/libcaja-extension-caja-info-provider.html#libcaja-extension-caja-info-provider.synopsis"> +<ANCHOR id="CajaInfoProvider" href="libcaja-extension/libcaja-extension-caja-info-provider.html#CajaInfoProvider"> +<ANCHOR id="libcaja-extension-caja-info-provider.object-hierarchy" href="libcaja-extension/libcaja-extension-caja-info-provider.html#libcaja-extension-caja-info-provider.object-hierarchy"> +<ANCHOR id="libcaja-extension-caja-info-provider.prerequisites" href="libcaja-extension/libcaja-extension-caja-info-provider.html#libcaja-extension-caja-info-provider.prerequisites"> +<ANCHOR id="libcaja-extension-caja-info-provider.description" href="libcaja-extension/libcaja-extension-caja-info-provider.html#libcaja-extension-caja-info-provider.description"> +<ANCHOR id="libcaja-extension-caja-info-provider.details" href="libcaja-extension/libcaja-extension-caja-info-provider.html#libcaja-extension-caja-info-provider.details"> +<ANCHOR id="CajaInfoProvider-struct" href="libcaja-extension/libcaja-extension-caja-info-provider.html#CajaInfoProvider-struct"> +<ANCHOR id="CajaInfoProviderIface" href="libcaja-extension/libcaja-extension-caja-info-provider.html#CajaInfoProviderIface"> +<ANCHOR id="CajaInfoProviderUpdateComplete" href="libcaja-extension/libcaja-extension-caja-info-provider.html#CajaInfoProviderUpdateComplete"> +<ANCHOR id="caja-info-provider-update-file-info" href="libcaja-extension/libcaja-extension-caja-info-provider.html#caja-info-provider-update-file-info"> +<ANCHOR id="caja-info-provider-cancel-update" href="libcaja-extension/libcaja-extension-caja-info-provider.html#caja-info-provider-cancel-update"> +<ANCHOR id="caja-info-provider-update-complete-invoke" href="libcaja-extension/libcaja-extension-caja-info-provider.html#caja-info-provider-update-complete-invoke"> +<ANCHOR id="libcaja-extension-caja-location-widget-provider" href="libcaja-extension/libcaja-extension-caja-location-widget-provider.html"> +<ANCHOR id="libcaja-extension-caja-location-widget-provider.synopsis" href="libcaja-extension/libcaja-extension-caja-location-widget-provider.html#libcaja-extension-caja-location-widget-provider.synopsis"> +<ANCHOR id="CajaLocationWidgetProvider" href="libcaja-extension/libcaja-extension-caja-location-widget-provider.html#CajaLocationWidgetProvider"> +<ANCHOR id="libcaja-extension-caja-location-widget-provider.object-hierarchy" href="libcaja-extension/libcaja-extension-caja-location-widget-provider.html#libcaja-extension-caja-location-widget-provider.object-hierarchy"> +<ANCHOR id="libcaja-extension-caja-location-widget-provider.prerequisites" href="libcaja-extension/libcaja-extension-caja-location-widget-provider.html#libcaja-extension-caja-location-widget-provider.prerequisites"> +<ANCHOR id="libcaja-extension-caja-location-widget-provider.description" href="libcaja-extension/libcaja-extension-caja-location-widget-provider.html#libcaja-extension-caja-location-widget-provider.description"> +<ANCHOR id="libcaja-extension-caja-location-widget-provider.details" href="libcaja-extension/libcaja-extension-caja-location-widget-provider.html#libcaja-extension-caja-location-widget-provider.details"> +<ANCHOR id="CajaLocationWidgetProvider-struct" href="libcaja-extension/libcaja-extension-caja-location-widget-provider.html#CajaLocationWidgetProvider-struct"> +<ANCHOR id="CajaLocationWidgetProviderIface" href="libcaja-extension/libcaja-extension-caja-location-widget-provider.html#CajaLocationWidgetProviderIface"> +<ANCHOR id="caja-location-widget-provider-get-widget" href="libcaja-extension/libcaja-extension-caja-location-widget-provider.html#caja-location-widget-provider-get-widget"> +<ANCHOR id="libcaja-extension-caja-menu-provider" href="libcaja-extension/libcaja-extension-caja-menu-provider.html"> +<ANCHOR id="libcaja-extension-caja-menu-provider.synopsis" href="libcaja-extension/libcaja-extension-caja-menu-provider.html#libcaja-extension-caja-menu-provider.synopsis"> +<ANCHOR id="CajaMenuProvider" href="libcaja-extension/libcaja-extension-caja-menu-provider.html#CajaMenuProvider"> +<ANCHOR id="libcaja-extension-caja-menu-provider.object-hierarchy" href="libcaja-extension/libcaja-extension-caja-menu-provider.html#libcaja-extension-caja-menu-provider.object-hierarchy"> +<ANCHOR id="libcaja-extension-caja-menu-provider.prerequisites" href="libcaja-extension/libcaja-extension-caja-menu-provider.html#libcaja-extension-caja-menu-provider.prerequisites"> +<ANCHOR id="libcaja-extension-caja-menu-provider.signals" href="libcaja-extension/libcaja-extension-caja-menu-provider.html#libcaja-extension-caja-menu-provider.signals"> +<ANCHOR id="libcaja-extension-caja-menu-provider.description" href="libcaja-extension/libcaja-extension-caja-menu-provider.html#libcaja-extension-caja-menu-provider.description"> +<ANCHOR id="libcaja-extension-caja-menu-provider.details" href="libcaja-extension/libcaja-extension-caja-menu-provider.html#libcaja-extension-caja-menu-provider.details"> +<ANCHOR id="CajaMenuProvider-struct" href="libcaja-extension/libcaja-extension-caja-menu-provider.html#CajaMenuProvider-struct"> +<ANCHOR id="CajaMenuProviderIface" href="libcaja-extension/libcaja-extension-caja-menu-provider.html#CajaMenuProviderIface"> +<ANCHOR id="caja-menu-provider-get-file-items" href="libcaja-extension/libcaja-extension-caja-menu-provider.html#caja-menu-provider-get-file-items"> +<ANCHOR id="caja-menu-provider-get-background-items" href="libcaja-extension/libcaja-extension-caja-menu-provider.html#caja-menu-provider-get-background-items"> +<ANCHOR id="caja-menu-provider-get-toolbar-items" href="libcaja-extension/libcaja-extension-caja-menu-provider.html#caja-menu-provider-get-toolbar-items"> +<ANCHOR id="caja-menu-provider-emit-items-updated-signal" href="libcaja-extension/libcaja-extension-caja-menu-provider.html#caja-menu-provider-emit-items-updated-signal"> +<ANCHOR id="libcaja-extension-caja-menu-provider.signal-details" href="libcaja-extension/libcaja-extension-caja-menu-provider.html#libcaja-extension-caja-menu-provider.signal-details"> +<ANCHOR id="CajaMenuProvider-items-updated" href="libcaja-extension/libcaja-extension-caja-menu-provider.html#CajaMenuProvider-items-updated"> +<ANCHOR id="libcaja-extension-caja-menu" href="libcaja-extension/libcaja-extension-caja-menu.html"> +<ANCHOR id="libcaja-extension-caja-menu.synopsis" href="libcaja-extension/libcaja-extension-caja-menu.html#libcaja-extension-caja-menu.synopsis"> +<ANCHOR id="CajaMenu" href="libcaja-extension/libcaja-extension-caja-menu.html#CajaMenu"> +<ANCHOR id="CajaMenuItem" href="libcaja-extension/libcaja-extension-caja-menu.html#CajaMenuItem"> +<ANCHOR id="libcaja-extension-caja-menu.object-hierarchy" href="libcaja-extension/libcaja-extension-caja-menu.html#libcaja-extension-caja-menu.object-hierarchy"> +<ANCHOR id="libcaja-extension-caja-menu.properties" href="libcaja-extension/libcaja-extension-caja-menu.html#libcaja-extension-caja-menu.properties"> +<ANCHOR id="libcaja-extension-caja-menu.signals" href="libcaja-extension/libcaja-extension-caja-menu.html#libcaja-extension-caja-menu.signals"> +<ANCHOR id="libcaja-extension-caja-menu.description" href="libcaja-extension/libcaja-extension-caja-menu.html#libcaja-extension-caja-menu.description"> +<ANCHOR id="libcaja-extension-caja-menu.details" href="libcaja-extension/libcaja-extension-caja-menu.html#libcaja-extension-caja-menu.details"> +<ANCHOR id="CAJA-TYPE-MENU-ITEM:CAPS" href="libcaja-extension/libcaja-extension-caja-menu.html#CAJA-TYPE-MENU-ITEM:CAPS"> +<ANCHOR id="CAJA-MENU-ITEM:CAPS" href="libcaja-extension/libcaja-extension-caja-menu.html#CAJA-MENU-ITEM:CAPS"> +<ANCHOR id="CAJA-MENU-ITEM-CLASS:CAPS" href="libcaja-extension/libcaja-extension-caja-menu.html#CAJA-MENU-ITEM-CLASS:CAPS"> +<ANCHOR id="CAJA-MENU-IS-ITEM:CAPS" href="libcaja-extension/libcaja-extension-caja-menu.html#CAJA-MENU-IS-ITEM:CAPS"> +<ANCHOR id="CAJA-MENU-IS-ITEM-CLASS:CAPS" href="libcaja-extension/libcaja-extension-caja-menu.html#CAJA-MENU-IS-ITEM-CLASS:CAPS"> +<ANCHOR id="CAJA-MENU-ITEM-GET-CLASS:CAPS" href="libcaja-extension/libcaja-extension-caja-menu.html#CAJA-MENU-ITEM-GET-CLASS:CAPS"> +<ANCHOR id="CajaMenuPrivate" href="libcaja-extension/libcaja-extension-caja-menu.html#CajaMenuPrivate"> +<ANCHOR id="CajaMenuItemDetails" href="libcaja-extension/libcaja-extension-caja-menu.html#CajaMenuItemDetails"> +<ANCHOR id="CajaMenu-struct" href="libcaja-extension/libcaja-extension-caja-menu.html#CajaMenu-struct"> +<ANCHOR id="CajaMenuItem-struct" href="libcaja-extension/libcaja-extension-caja-menu.html#CajaMenuItem-struct"> +<ANCHOR id="caja-menu-new" href="libcaja-extension/libcaja-extension-caja-menu.html#caja-menu-new"> +<ANCHOR id="caja-menu-append-item" href="libcaja-extension/libcaja-extension-caja-menu.html#caja-menu-append-item"> +<ANCHOR id="caja-menu-get-items" href="libcaja-extension/libcaja-extension-caja-menu.html#caja-menu-get-items"> +<ANCHOR id="caja-menu-item-list-free" href="libcaja-extension/libcaja-extension-caja-menu.html#caja-menu-item-list-free"> +<ANCHOR id="caja-menu-item-get-type" href="libcaja-extension/libcaja-extension-caja-menu.html#caja-menu-item-get-type"> +<ANCHOR id="caja-menu-item-new" href="libcaja-extension/libcaja-extension-caja-menu.html#caja-menu-item-new"> +<ANCHOR id="caja-menu-item-activate" href="libcaja-extension/libcaja-extension-caja-menu.html#caja-menu-item-activate"> +<ANCHOR id="caja-menu-item-set-submenu" href="libcaja-extension/libcaja-extension-caja-menu.html#caja-menu-item-set-submenu"> +<ANCHOR id="libcaja-extension-caja-menu.property-details" href="libcaja-extension/libcaja-extension-caja-menu.html#libcaja-extension-caja-menu.property-details"> +<ANCHOR id="CajaMenuItem--icon" href="libcaja-extension/libcaja-extension-caja-menu.html#CajaMenuItem--icon"> +<ANCHOR id="CajaMenuItem--label" href="libcaja-extension/libcaja-extension-caja-menu.html#CajaMenuItem--label"> +<ANCHOR id="CajaMenuItem--menu" href="libcaja-extension/libcaja-extension-caja-menu.html#CajaMenuItem--menu"> +<ANCHOR id="CajaMenuItem--name" href="libcaja-extension/libcaja-extension-caja-menu.html#CajaMenuItem--name"> +<ANCHOR id="CajaMenuItem--priority" href="libcaja-extension/libcaja-extension-caja-menu.html#CajaMenuItem--priority"> +<ANCHOR id="CajaMenuItem--sensitive" href="libcaja-extension/libcaja-extension-caja-menu.html#CajaMenuItem--sensitive"> +<ANCHOR id="CajaMenuItem--tip" href="libcaja-extension/libcaja-extension-caja-menu.html#CajaMenuItem--tip"> +<ANCHOR id="libcaja-extension-caja-menu.signal-details" href="libcaja-extension/libcaja-extension-caja-menu.html#libcaja-extension-caja-menu.signal-details"> +<ANCHOR id="CajaMenuItem-activate" href="libcaja-extension/libcaja-extension-caja-menu.html#CajaMenuItem-activate"> +<ANCHOR id="libcaja-extension-caja-property-page-provider" href="libcaja-extension/libcaja-extension-caja-property-page-provider.html"> +<ANCHOR id="libcaja-extension-caja-property-page-provider.synopsis" href="libcaja-extension/libcaja-extension-caja-property-page-provider.html#libcaja-extension-caja-property-page-provider.synopsis"> +<ANCHOR id="CajaPropertyPageProvider" href="libcaja-extension/libcaja-extension-caja-property-page-provider.html#CajaPropertyPageProvider"> +<ANCHOR id="libcaja-extension-caja-property-page-provider.object-hierarchy" href="libcaja-extension/libcaja-extension-caja-property-page-provider.html#libcaja-extension-caja-property-page-provider.object-hierarchy"> +<ANCHOR id="libcaja-extension-caja-property-page-provider.prerequisites" href="libcaja-extension/libcaja-extension-caja-property-page-provider.html#libcaja-extension-caja-property-page-provider.prerequisites"> +<ANCHOR id="libcaja-extension-caja-property-page-provider.description" href="libcaja-extension/libcaja-extension-caja-property-page-provider.html#libcaja-extension-caja-property-page-provider.description"> +<ANCHOR id="libcaja-extension-caja-property-page-provider.details" href="libcaja-extension/libcaja-extension-caja-property-page-provider.html#libcaja-extension-caja-property-page-provider.details"> +<ANCHOR id="CajaPropertyPageProvider-struct" href="libcaja-extension/libcaja-extension-caja-property-page-provider.html#CajaPropertyPageProvider-struct"> +<ANCHOR id="CajaPropertyPageProviderIface" href="libcaja-extension/libcaja-extension-caja-property-page-provider.html#CajaPropertyPageProviderIface"> +<ANCHOR id="caja-property-page-provider-get-pages" href="libcaja-extension/libcaja-extension-caja-property-page-provider.html#caja-property-page-provider-get-pages"> +<ANCHOR id="libcaja-extension-caja-property-page" href="libcaja-extension/libcaja-extension-caja-property-page.html"> +<ANCHOR id="libcaja-extension-caja-property-page.synopsis" href="libcaja-extension/libcaja-extension-caja-property-page.html#libcaja-extension-caja-property-page.synopsis"> +<ANCHOR id="CajaPropertyPage" href="libcaja-extension/libcaja-extension-caja-property-page.html#CajaPropertyPage"> +<ANCHOR id="libcaja-extension-caja-property-page.object-hierarchy" href="libcaja-extension/libcaja-extension-caja-property-page.html#libcaja-extension-caja-property-page.object-hierarchy"> +<ANCHOR id="libcaja-extension-caja-property-page.properties" href="libcaja-extension/libcaja-extension-caja-property-page.html#libcaja-extension-caja-property-page.properties"> +<ANCHOR id="libcaja-extension-caja-property-page.description" href="libcaja-extension/libcaja-extension-caja-property-page.html#libcaja-extension-caja-property-page.description"> +<ANCHOR id="libcaja-extension-caja-property-page.details" href="libcaja-extension/libcaja-extension-caja-property-page.html#libcaja-extension-caja-property-page.details"> +<ANCHOR id="CajaPropertyPageDetails" href="libcaja-extension/libcaja-extension-caja-property-page.html#CajaPropertyPageDetails"> +<ANCHOR id="CajaPropertyPage-struct" href="libcaja-extension/libcaja-extension-caja-property-page.html#CajaPropertyPage-struct"> +<ANCHOR id="caja-property-page-new" href="libcaja-extension/libcaja-extension-caja-property-page.html#caja-property-page-new"> +<ANCHOR id="libcaja-extension-caja-property-page.property-details" href="libcaja-extension/libcaja-extension-caja-property-page.html#libcaja-extension-caja-property-page.property-details"> +<ANCHOR id="CajaPropertyPage--label" href="libcaja-extension/libcaja-extension-caja-property-page.html#CajaPropertyPage--label"> +<ANCHOR id="CajaPropertyPage--name" href="libcaja-extension/libcaja-extension-caja-property-page.html#CajaPropertyPage--name"> +<ANCHOR id="CajaPropertyPage--page" href="libcaja-extension/libcaja-extension-caja-property-page.html#CajaPropertyPage--page"> 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Index</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Caja Extension Reference Manual"> +<link rel="up" href="index.html" title="Caja Extension Reference Manual"> +<link rel="prev" href="libcaja-extension-caja-property-page.html" title="CajaPropertyPage"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="libcaja-extension-caja-property-page.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td>Â </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Caja Extension Reference Manual</th> +<td>Â </td> +</tr></table> +<div class="index" title="Index"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="id2829821"></a>Index</h2></div></div></div> +<div class="index"><div class="indexdiv"> +<h3>N</h3> +<dl> +<dt>CajaColumn, <a class="indexterm" href="libcaja-extension-caja-column.html#CajaColumn-struct">CajaColumn</a> +</dt> +<dt>CajaColumn:attribute, <a class="indexterm" href="libcaja-extension-caja-column.html#CajaColumn--attribute">The "attribute" property</a> +</dt> +<dt>CajaColumn:attribute-q, <a class="indexterm" href="libcaja-extension-caja-column.html#CajaColumn--attribute-q">The "attribute-q" property</a> +</dt> +<dt>CajaColumn:description, <a class="indexterm" href="libcaja-extension-caja-column.html#CajaColumn--description">The "description" property</a> +</dt> +<dt>CajaColumn:label, <a class="indexterm" href="libcaja-extension-caja-column.html#CajaColumn--label">The "label" property</a> +</dt> +<dt>CajaColumn:name, <a class="indexterm" href="libcaja-extension-caja-column.html#CajaColumn--name">The "name" property</a> +</dt> +<dt>CajaColumn:xalign, <a class="indexterm" href="libcaja-extension-caja-column.html#CajaColumn--xalign">The "xalign" property</a> +</dt> +<dt>CajaColumnDetails, <a class="indexterm" href="libcaja-extension-caja-column.html#CajaColumnDetails">CajaColumnDetails</a> +</dt> +<dt>CajaColumnProvider, <a class="indexterm" href="libcaja-extension-caja-column-provider.html#CajaColumnProvider-struct">CajaColumnProvider</a> +</dt> +<dt>CajaColumnProviderIface, <a class="indexterm" href="libcaja-extension-caja-column-provider.html#CajaColumnProviderIface">CajaColumnProviderIface</a> +</dt> +<dt>CajaFile, <a class="indexterm" href="libcaja-extension-caja-file-info.html#CajaFile">CajaFile</a> +</dt> +<dt>CajaFileInfo, <a class="indexterm" href="libcaja-extension-caja-file-info.html#CajaFileInfo">caja-file-info</a> +</dt> +<dt>CajaFileInfoIface, <a class="indexterm" href="libcaja-extension-caja-file-info.html#CajaFileInfoIface">CajaFileInfoIface</a> +</dt> +<dt>CajaInfoProvider, <a class="indexterm" href="libcaja-extension-caja-info-provider.html#CajaInfoProvider-struct">CajaInfoProvider</a> +</dt> +<dt>CajaInfoProviderIface, <a class="indexterm" href="libcaja-extension-caja-info-provider.html#CajaInfoProviderIface">CajaInfoProviderIface</a> +</dt> +<dt>CajaInfoProviderUpdateComplete, <a class="indexterm" href="libcaja-extension-caja-info-provider.html#CajaInfoProviderUpdateComplete">CajaInfoProviderUpdateComplete ()</a> +</dt> +<dt>CajaLocationWidgetProvider, <a class="indexterm" href="libcaja-extension-caja-location-widget-provider.html#CajaLocationWidgetProvider-struct">CajaLocationWidgetProvider</a> +</dt> +<dt>CajaLocationWidgetProviderIface, <a class="indexterm" href="libcaja-extension-caja-location-widget-provider.html#CajaLocationWidgetProviderIface">CajaLocationWidgetProviderIface</a> +</dt> +<dt>CajaMenu, <a class="indexterm" href="libcaja-extension-caja-menu.html#CajaMenu-struct">CajaMenu</a> +</dt> +<dt>CajaMenuItem, <a class="indexterm" href="libcaja-extension-caja-menu.html#CajaMenuItem-struct">CajaMenuItem</a> +</dt> +<dt>CajaMenuItem::activate, <a class="indexterm" href="libcaja-extension-caja-menu.html#CajaMenuItem-activate">The "activate" signal</a> +</dt> +<dt>CajaMenuItem:icon, <a class="indexterm" href="libcaja-extension-caja-menu.html#CajaMenuItem--icon">The "icon" property</a> +</dt> +<dt>CajaMenuItem:label, <a class="indexterm" href="libcaja-extension-caja-menu.html#CajaMenuItem--label">The "label" property</a> +</dt> +<dt>CajaMenuItem:menu, <a class="indexterm" href="libcaja-extension-caja-menu.html#CajaMenuItem--menu">The "menu" property</a> +</dt> +<dt>CajaMenuItem:name, <a class="indexterm" href="libcaja-extension-caja-menu.html#CajaMenuItem--name">The "name" property</a> +</dt> +<dt>CajaMenuItem:priority, <a class="indexterm" href="libcaja-extension-caja-menu.html#CajaMenuItem--priority">The "priority" property</a> +</dt> +<dt>CajaMenuItem:sensitive, <a class="indexterm" href="libcaja-extension-caja-menu.html#CajaMenuItem--sensitive">The "sensitive" property</a> +</dt> +<dt>CajaMenuItem:tip, <a class="indexterm" href="libcaja-extension-caja-menu.html#CajaMenuItem--tip">The "tip" property</a> +</dt> +<dt>CajaMenuItemDetails, <a class="indexterm" href="libcaja-extension-caja-menu.html#CajaMenuItemDetails">CajaMenuItemDetails</a> +</dt> +<dt>CajaMenuPrivate, <a class="indexterm" href="libcaja-extension-caja-menu.html#CajaMenuPrivate">CajaMenuPrivate</a> +</dt> +<dt>CajaMenuProvider, <a class="indexterm" href="libcaja-extension-caja-menu-provider.html#CajaMenuProvider-struct">CajaMenuProvider</a> +</dt> +<dt>CajaMenuProvider::items-updated, <a class="indexterm" href="libcaja-extension-caja-menu-provider.html#CajaMenuProvider-items-updated">The "items-updated" signal</a> +</dt> +<dt>CajaMenuProviderIface, <a class="indexterm" href="libcaja-extension-caja-menu-provider.html#CajaMenuProviderIface">CajaMenuProviderIface</a> +</dt> +<dt>CajaOperationHandle, <a class="indexterm" href="libcaja-extension-caja-extension-types.html#CajaOperationHandle">CajaOperationHandle</a> +</dt> +<dt>CajaOperationResult, <a class="indexterm" href="libcaja-extension-caja-extension-types.html#CajaOperationResult">enum CajaOperationResult</a> +</dt> +<dt>CajaPropertyPage, <a class="indexterm" href="libcaja-extension-caja-property-page.html#CajaPropertyPage-struct">CajaPropertyPage</a> +</dt> +<dt>CajaPropertyPage:label, <a class="indexterm" href="libcaja-extension-caja-property-page.html#CajaPropertyPage--label">The "label" property</a> +</dt> +<dt>CajaPropertyPage:name, <a class="indexterm" href="libcaja-extension-caja-property-page.html#CajaPropertyPage--name">The "name" property</a> +</dt> +<dt>CajaPropertyPage:page, <a class="indexterm" href="libcaja-extension-caja-property-page.html#CajaPropertyPage--page">The "page" property</a> +</dt> +<dt>CajaPropertyPageDetails, <a class="indexterm" href="libcaja-extension-caja-property-page.html#CajaPropertyPageDetails">CajaPropertyPageDetails</a> +</dt> +<dt>CajaPropertyPageProvider, <a class="indexterm" href="libcaja-extension-caja-property-page-provider.html#CajaPropertyPageProvider-struct">CajaPropertyPageProvider</a> +</dt> +<dt>CajaPropertyPageProviderIface, <a class="indexterm" href="libcaja-extension-caja-property-page-provider.html#CajaPropertyPageProviderIface">CajaPropertyPageProviderIface</a> +</dt> +<dt>caja_column_new, <a class="indexterm" href="libcaja-extension-caja-column.html#caja-column-new">caja_column_new ()</a> +</dt> +<dt>caja_column_provider_get_columns, <a class="indexterm" href="libcaja-extension-caja-column-provider.html#caja-column-provider-get-columns">caja_column_provider_get_columns ()</a> +</dt> +<dt>CAJA_FILE_DEFINED, <a class="indexterm" href="libcaja-extension-caja-file-info.html#CAJA-FILE-DEFINED:CAPS">CAJA_FILE_DEFINED</a> +</dt> +<dt>caja_file_info_add_emblem, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-add-emblem">caja_file_info_add_emblem ()</a> +</dt> +<dt>caja_file_info_add_string_attribute, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-add-string-attribute">caja_file_info_add_string_attribute ()</a> +</dt> +<dt>caja_file_info_can_write, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-can-write">caja_file_info_can_write ()</a> +</dt> +<dt>caja_file_info_get_activation_uri, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-get-activation-uri">caja_file_info_get_activation_uri ()</a> +</dt> +<dt>caja_file_info_get_file_type, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-get-file-type">caja_file_info_get_file_type ()</a> +</dt> +<dt>caja_file_info_get_location, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-get-location">caja_file_info_get_location ()</a> +</dt> +<dt>caja_file_info_get_mime_type, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-get-mime-type">caja_file_info_get_mime_type ()</a> +</dt> +<dt>caja_file_info_get_mount, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-get-mount">caja_file_info_get_mount ()</a> +</dt> +<dt>caja_file_info_get_name, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-get-name">caja_file_info_get_name ()</a> +</dt> +<dt>caja_file_info_get_parent_info, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-get-parent-info">caja_file_info_get_parent_info ()</a> +</dt> +<dt>caja_file_info_get_parent_location, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-get-parent-location">caja_file_info_get_parent_location ()</a> +</dt> +<dt>caja_file_info_get_parent_uri, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-get-parent-uri">caja_file_info_get_parent_uri ()</a> +</dt> +<dt>caja_file_info_get_string_attribute, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-get-string-attribute">caja_file_info_get_string_attribute ()</a> +</dt> +<dt>caja_file_info_get_uri, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-get-uri">caja_file_info_get_uri ()</a> +</dt> +<dt>caja_file_info_get_uri_scheme, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-get-uri-scheme">caja_file_info_get_uri_scheme ()</a> +</dt> +<dt>caja_file_info_invalidate_extension_info, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-invalidate-extension-info">caja_file_info_invalidate_extension_info ()</a> +</dt> +<dt>caja_file_info_is_directory, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-is-directory">caja_file_info_is_directory ()</a> +</dt> +<dt>caja_file_info_is_gone, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-is-gone">caja_file_info_is_gone ()</a> +</dt> +<dt>caja_file_info_is_mime_type, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-is-mime-type">caja_file_info_is_mime_type ()</a> +</dt> +<dt>caja_file_info_list_copy, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-list-copy">caja_file_info_list_copy ()</a> +</dt> +<dt>caja_file_info_list_free, <a class="indexterm" href="libcaja-extension-caja-file-info.html#caja-file-info-list-free">caja_file_info_list_free ()</a> +</dt> +<dt>caja_info_provider_cancel_update, <a class="indexterm" href="libcaja-extension-caja-info-provider.html#caja-info-provider-cancel-update">caja_info_provider_cancel_update ()</a> +</dt> +<dt>caja_info_provider_update_complete_invoke, <a class="indexterm" href="libcaja-extension-caja-info-provider.html#caja-info-provider-update-complete-invoke">caja_info_provider_update_complete_invoke ()</a> +</dt> +<dt>caja_info_provider_update_file_info, <a class="indexterm" href="libcaja-extension-caja-info-provider.html#caja-info-provider-update-file-info">caja_info_provider_update_file_info ()</a> +</dt> +<dt>caja_location_widget_provider_get_widget, <a class="indexterm" href="libcaja-extension-caja-location-widget-provider.html#caja-location-widget-provider-get-widget">caja_location_widget_provider_get_widget ()</a> +</dt> +<dt>caja_menu_append_item, <a class="indexterm" href="libcaja-extension-caja-menu.html#caja-menu-append-item">caja_menu_append_item ()</a> +</dt> +<dt>caja_menu_get_items, <a class="indexterm" href="libcaja-extension-caja-menu.html#caja-menu-get-items">caja_menu_get_items ()</a> +</dt> +<dt>CAJA_MENU_IS_ITEM, <a class="indexterm" href="libcaja-extension-caja-menu.html#CAJA-MENU-IS-ITEM:CAPS">CAJA_MENU_IS_ITEM()</a> +</dt> +<dt>CAJA_MENU_IS_ITEM_CLASS, <a class="indexterm" href="libcaja-extension-caja-menu.html#CAJA-MENU-IS-ITEM-CLASS:CAPS">CAJA_MENU_IS_ITEM_CLASS()</a> +</dt> +<dt>CAJA_MENU_ITEM, <a class="indexterm" href="libcaja-extension-caja-menu.html#CAJA-MENU-ITEM:CAPS">CAJA_MENU_ITEM()</a> +</dt> +<dt>caja_menu_item_activate, <a class="indexterm" href="libcaja-extension-caja-menu.html#caja-menu-item-activate">caja_menu_item_activate ()</a> +</dt> +<dt>CAJA_MENU_ITEM_CLASS, <a class="indexterm" href="libcaja-extension-caja-menu.html#CAJA-MENU-ITEM-CLASS:CAPS">CAJA_MENU_ITEM_CLASS()</a> +</dt> +<dt>CAJA_MENU_ITEM_GET_CLASS, <a class="indexterm" href="libcaja-extension-caja-menu.html#CAJA-MENU-ITEM-GET-CLASS:CAPS">CAJA_MENU_ITEM_GET_CLASS()</a> +</dt> +<dt>caja_menu_item_get_type, <a class="indexterm" href="libcaja-extension-caja-menu.html#caja-menu-item-get-type">caja_menu_item_get_type ()</a> +</dt> +<dt>caja_menu_item_list_free, <a class="indexterm" href="libcaja-extension-caja-menu.html#caja-menu-item-list-free">caja_menu_item_list_free ()</a> +</dt> +<dt>caja_menu_item_new, <a class="indexterm" href="libcaja-extension-caja-menu.html#caja-menu-item-new">caja_menu_item_new ()</a> +</dt> +<dt>caja_menu_item_set_submenu, <a class="indexterm" href="libcaja-extension-caja-menu.html#caja-menu-item-set-submenu">caja_menu_item_set_submenu ()</a> +</dt> +<dt>caja_menu_new, <a class="indexterm" href="libcaja-extension-caja-menu.html#caja-menu-new">caja_menu_new ()</a> +</dt> +<dt>caja_menu_provider_emit_items_updated_signal, <a class="indexterm" href="libcaja-extension-caja-menu-provider.html#caja-menu-provider-emit-items-updated-signal">caja_menu_provider_emit_items_updated_signal ()</a> +</dt> +<dt>caja_menu_provider_get_background_items, <a class="indexterm" href="libcaja-extension-caja-menu-provider.html#caja-menu-provider-get-background-items">caja_menu_provider_get_background_items ()</a> +</dt> +<dt>caja_menu_provider_get_file_items, <a class="indexterm" href="libcaja-extension-caja-menu-provider.html#caja-menu-provider-get-file-items">caja_menu_provider_get_file_items ()</a> +</dt> +<dt>caja_menu_provider_get_toolbar_items, <a class="indexterm" href="libcaja-extension-caja-menu-provider.html#caja-menu-provider-get-toolbar-items">caja_menu_provider_get_toolbar_items ()</a> +</dt> +<dt>caja_module_initialize, <a class="indexterm" href="libcaja-extension-caja-extension-types.html#caja-module-initialize">caja_module_initialize ()</a> +</dt> +<dt>caja_module_list_types, <a class="indexterm" href="libcaja-extension-caja-extension-types.html#caja-module-list-types">caja_module_list_types ()</a> +</dt> +<dt>caja_module_shutdown, <a class="indexterm" href="libcaja-extension-caja-extension-types.html#caja-module-shutdown">caja_module_shutdown ()</a> +</dt> +<dt>caja_operation_result_get_type, <a class="indexterm" href="libcaja-extension-caja-extension-types.html#caja-operation-result-get-type">caja_operation_result_get_type ()</a> +</dt> +<dt>caja_property_page_new, <a class="indexterm" href="libcaja-extension-caja-property-page.html#caja-property-page-new">caja_property_page_new ()</a> +</dt> +<dt>caja_property_page_provider_get_pages, <a class="indexterm" href="libcaja-extension-caja-property-page-provider.html#caja-property-page-provider-get-pages">caja_property_page_provider_get_pages ()</a> +</dt> +<dt>CAJA_TYPE_MENU_ITEM, <a class="indexterm" href="libcaja-extension-caja-menu.html#CAJA-TYPE-MENU-ITEM:CAPS">CAJA_TYPE_MENU_ITEM</a> +</dt> +<dt>CAJA_TYPE_OPERATION_RESULT, <a class="indexterm" href="libcaja-extension-caja-extension-types.html#CAJA-TYPE-OPERATION-RESULT:CAPS">CAJA_TYPE_OPERATION_RESULT</a> +</dt> +</dl> +</div></div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/libcaja-extension/html/left.png b/docs/reference/libcaja-extension/html/left.png Binary files differnew file mode 100644 index 00000000..2d05b3d5 --- /dev/null +++ b/docs/reference/libcaja-extension/html/left.png 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>caja-column-provider</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Caja Extension Reference Manual"> +<link rel="up" href="ch01.html" title="Extension Interfaces"> +<link rel="prev" href="ch01.html" title="Extension Interfaces"> +<link rel="next" href="libcaja-extension-caja-column.html" title="CajaColumn"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Caja Extension Reference Manual</th> +<td><a accesskey="n" href="libcaja-extension-caja-column.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#libcaja-extension-caja-column-provider.synopsis" class="shortcut">Top</a> +  | + <a href="#libcaja-extension-caja-column-provider.description" class="shortcut">Description</a> +  | + <a href="#libcaja-extension-caja-column-provider.object-hierarchy" class="shortcut">Object Hierarchy</a> +  | + <a href="#libcaja-extension-caja-column-provider.prerequisites" class="shortcut">Prerequisites</a> +</td></tr> +</table> +<div class="refentry" title="caja-column-provider"> +<a name="libcaja-extension-caja-column-provider"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libcaja-extension-caja-column-provider.top_of_page"></a>caja-column-provider</span></h2> +<p>caja-column-provider</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="libcaja-extension-caja-column-provider.synopsis"></a><h2>Synopsis</h2> +<a name="CajaColumnProvider"></a><pre class="synopsis"> <a class="link" href="libcaja-extension-caja-column-provider.html#CajaColumnProvider-struct" title="CajaColumnProvider">CajaColumnProvider</a>; + <a class="link" href="libcaja-extension-caja-column-provider.html#CajaColumnProviderIface" title="CajaColumnProviderIface">CajaColumnProviderIface</a>; +<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * <a class="link" href="libcaja-extension-caja-column-provider.html#caja-column-provider-get-columns" title="caja_column_provider_get_columns ()">caja_column_provider_get_columns</a> + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-column-provider.html#CajaColumnProvider"><span class="type">CajaColumnProvider</span></a> *provider</code></em>); +</pre> +</div> +<div class="refsect1" title="Object Hierarchy"> +<a name="libcaja-extension-caja-column-provider.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GInterface + +----CajaColumnProvider +</pre> +</div> +<div class="refsect1" title="Prerequisites"> +<a name="libcaja-extension-caja-column-provider.prerequisites"></a><h2>Prerequisites</h2> +<p> +CajaColumnProvider requires + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p> +</div> +<div class="refsect1" title="Description"> +<a name="libcaja-extension-caja-column-provider.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="libcaja-extension-caja-column-provider.details"></a><h2>Details</h2> +<div class="refsect2" title="CajaColumnProvider"> +<a name="CajaColumnProvider-struct"></a><h3>CajaColumnProvider</h3> +<pre class="programlisting">typedef struct _CajaColumnProvider CajaColumnProvider;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="CajaColumnProviderIface"> +<a name="CajaColumnProviderIface"></a><h3>CajaColumnProviderIface</h3> +<pre class="programlisting">typedef struct { + GTypeInterface g_iface; + + GList *(*get_columns) (CajaColumnProvider *provider); +} CajaColumnProviderIface; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="caja_column_provider_get_columns ()"> +<a name="caja-column-provider-get-columns"></a><h3>caja_column_provider_get_columns ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * caja_column_provider_get_columns + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-column-provider.html#CajaColumnProvider"><span class="type">CajaColumnProvider</span></a> *provider</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html> 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>CajaColumn</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Caja Extension Reference Manual"> +<link rel="up" href="ch01.html" title="Extension Interfaces"> +<link rel="prev" href="libcaja-extension-caja-column-provider.html" title="caja-column-provider"> +<link rel="next" href="libcaja-extension-caja-extension-types.html" title="caja-extension-types"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="libcaja-extension-caja-column-provider.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Caja Extension Reference Manual</th> +<td><a accesskey="n" href="libcaja-extension-caja-extension-types.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#libcaja-extension-caja-column.synopsis" class="shortcut">Top</a> +  | + <a href="#libcaja-extension-caja-column.description" class="shortcut">Description</a> +  | + <a href="#libcaja-extension-caja-column.object-hierarchy" class="shortcut">Object Hierarchy</a> +  | + <a href="#libcaja-extension-caja-column.properties" class="shortcut">Properties</a> +</td></tr> +</table> +<div class="refentry" title="CajaColumn"> +<a name="libcaja-extension-caja-column"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libcaja-extension-caja-column.top_of_page"></a>CajaColumn</span></h2> +<p>CajaColumn</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="libcaja-extension-caja-column.synopsis"></a><h2>Synopsis</h2> +<a name="CajaColumn"></a><pre class="synopsis"> <a class="link" href="libcaja-extension-caja-column.html#CajaColumnDetails" title="CajaColumnDetails">CajaColumnDetails</a>; + <a class="link" href="libcaja-extension-caja-column.html#CajaColumn-struct" title="CajaColumn">CajaColumn</a>; +<a class="link" href="libcaja-extension-caja-column.html#CajaColumn"><span class="returnvalue">CajaColumn</span></a> * <a class="link" href="libcaja-extension-caja-column.html#caja-column-new" title="caja_column_new ()">caja_column_new</a> (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *label</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *description</code></em>); +</pre> +</div> +<div class="refsect1" title="Object Hierarchy"> +<a name="libcaja-extension-caja-column.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----CajaColumn +</pre> +</div> +<div class="refsect1" title="Properties"> +<a name="libcaja-extension-caja-column.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="libcaja-extension-caja-column.html#CajaColumn--attribute" title='The "attribute" property'>attribute</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="libcaja-extension-caja-column.html#CajaColumn--attribute-q" title='The "attribute-q" property'>attribute-q</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read + "<a class="link" href="libcaja-extension-caja-column.html#CajaColumn--description" title='The "description" property'>description</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="libcaja-extension-caja-column.html#CajaColumn--label" title='The "label" property'>label</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="libcaja-extension-caja-column.html#CajaColumn--name" title='The "name" property'>name</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only + "<a class="link" href="libcaja-extension-caja-column.html#CajaColumn--xalign" title='The "xalign" property'>xalign</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write +</pre> +</div> +<div class="refsect1" title="Description"> +<a name="libcaja-extension-caja-column.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="libcaja-extension-caja-column.details"></a><h2>Details</h2> +<div class="refsect2" title="CajaColumnDetails"> +<a name="CajaColumnDetails"></a><h3>CajaColumnDetails</h3> +<pre class="programlisting">typedef struct _CajaColumnDetails CajaColumnDetails;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="CajaColumn"> +<a name="CajaColumn-struct"></a><h3>CajaColumn</h3> +<pre class="programlisting">typedef struct _CajaColumn CajaColumn;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="caja_column_new ()"> +<a name="caja-column-new"></a><h3>caja_column_new ()</h3> +<pre class="programlisting"><a class="link" href="libcaja-extension-caja-column.html#CajaColumn"><span class="returnvalue">CajaColumn</span></a> * caja_column_new (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *attribute</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *label</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *description</code></em>);</pre> +<p> +Creates a new column +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>identifier of the column +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>attribute</code></em> :</span></p></td> +<td>the file attribute to be displayed in the column +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td> +<td>the user-visible label for the column +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td> +<td>a user-visible description of the column +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> a newly created <a class="link" href="libcaja-extension-caja-column.html#CajaColumn"><span class="type">CajaColumn</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1" title="Property Details"> +<a name="libcaja-extension-caja-column.property-details"></a><h2>Property Details</h2> +<div class="refsect2" title='The "attribute" property'> +<a name="CajaColumn--attribute"></a><h3>The <code class="literal">"attribute"</code> property</h3> +<pre class="programlisting"> "attribute" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p>The attribute name to display.</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "attribute-q" property'> +<a name="CajaColumn--attribute-q"></a><h3>The <code class="literal">"attribute-q"</code> property</h3> +<pre class="programlisting"> "attribute-q" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre> +<p>The attribute name to display, in quark form.</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2" title='The "description" property'> +<a name="CajaColumn--description"></a><h3>The <code class="literal">"description"</code> property</h3> +<pre class="programlisting"> "description" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p>A user-visible description of the column.</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "label" property'> +<a name="CajaColumn--label"></a><h3>The <code class="literal">"label"</code> property</h3> +<pre class="programlisting"> "label" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p>Label to display in the column.</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "name" property'> +<a name="CajaColumn--name"></a><h3>The <code class="literal">"name"</code> property</h3> +<pre class="programlisting"> "name" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre> +<p>Name of the column.</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "xalign" property'> +<a name="CajaColumn--xalign"></a><h3>The <code class="literal">"xalign"</code> property</h3> +<pre class="programlisting"> "xalign" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write</pre> +<p>The x-alignment of the column.</p> +<p>Allowed values: [0,1]</p> +<p>Default value: 0</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html> 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>caja-extension-types</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Caja Extension Reference Manual"> +<link rel="up" href="ch01.html" title="Extension Interfaces"> +<link rel="prev" href="libcaja-extension-caja-column.html" title="CajaColumn"> +<link rel="next" href="libcaja-extension-caja-file-info.html" title="caja-file-info"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="libcaja-extension-caja-column.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Caja Extension Reference Manual</th> +<td><a accesskey="n" href="libcaja-extension-caja-file-info.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#libcaja-extension-caja-extension-types.synopsis" class="shortcut">Top</a> +  | + <a href="#libcaja-extension-caja-extension-types.description" class="shortcut">Description</a> +</td></tr> +</table> +<div class="refentry" title="caja-extension-types"> +<a name="libcaja-extension-caja-extension-types"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libcaja-extension-caja-extension-types.top_of_page"></a>caja-extension-types</span></h2> +<p>caja-extension-types</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="libcaja-extension-caja-extension-types.synopsis"></a><h2>Synopsis</h2> +<pre class="synopsis">#define <a class="link" href="libcaja-extension-caja-extension-types.html#CAJA-TYPE-OPERATION-RESULT:CAPS" title="CAJA_TYPE_OPERATION_RESULT">CAJA_TYPE_OPERATION_RESULT</a> + <a class="link" href="libcaja-extension-caja-extension-types.html#CajaOperationHandle" title="CajaOperationHandle">CajaOperationHandle</a>; +enum <a class="link" href="libcaja-extension-caja-extension-types.html#CajaOperationResult" title="enum CajaOperationResult">CajaOperationResult</a>; +<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="libcaja-extension-caja-extension-types.html#caja-operation-result-get-type" title="caja_operation_result_get_type ()">caja_operation_result_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<span class="returnvalue">void</span> <a class="link" href="libcaja-extension-caja-extension-types.html#caja-module-initialize" title="caja_module_initialize ()">caja_module_initialize</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"><span class="type">GTypeModule</span></a> *module</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libcaja-extension-caja-extension-types.html#caja-module-shutdown" title="caja_module_shutdown ()">caja_module_shutdown</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<span class="returnvalue">void</span> <a class="link" href="libcaja-extension-caja-extension-types.html#caja-module-list-types" title="caja_module_list_types ()">caja_module_list_types</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> **types</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gnutls/gnutls-crypto.html#int"><span class="type">int</span></a> *num_types</code></em>); +</pre> +</div> +<div class="refsect1" title="Description"> +<a name="libcaja-extension-caja-extension-types.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="libcaja-extension-caja-extension-types.details"></a><h2>Details</h2> +<div class="refsect2" title="CAJA_TYPE_OPERATION_RESULT"> +<a name="CAJA-TYPE-OPERATION-RESULT:CAPS"></a><h3>CAJA_TYPE_OPERATION_RESULT</h3> +<pre class="programlisting">#define CAJA_TYPE_OPERATION_RESULT (caja_operation_result_get_type ()) +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="CajaOperationHandle"> +<a name="CajaOperationHandle"></a><h3>CajaOperationHandle</h3> +<pre class="programlisting">typedef struct _CajaOperationHandle CajaOperationHandle;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="enum CajaOperationResult"> +<a name="CajaOperationResult"></a><h3>enum CajaOperationResult</h3> +<pre class="programlisting">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; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="caja_operation_result_get_type ()"> +<a name="caja-operation-result-get-type"></a><h3>caja_operation_result_get_type ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> caja_operation_result_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_module_initialize ()"> +<a name="caja-module-initialize"></a><h3>caja_module_initialize ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> caja_module_initialize (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"><span class="type">GTypeModule</span></a> *module</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_module_shutdown ()"> +<a name="caja-module-shutdown"></a><h3>caja_module_shutdown ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> caja_module_shutdown (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="caja_module_list_types ()"> +<a name="caja-module-list-types"></a><h3>caja_module_list_types ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> caja_module_list_types (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> **types</code></em>, + <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gnutls/gnutls-crypto.html#int"><span class="type">int</span></a> *num_types</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>types</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>num_types</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html> 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>caja-file-info</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Caja Extension Reference Manual"> +<link rel="up" href="ch01.html" title="Extension Interfaces"> +<link rel="prev" href="libcaja-extension-caja-extension-types.html" title="caja-extension-types"> +<link rel="next" href="libcaja-extension-caja-info-provider.html" title="caja-info-provider"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="libcaja-extension-caja-extension-types.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Caja Extension Reference Manual</th> +<td><a accesskey="n" href="libcaja-extension-caja-info-provider.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#libcaja-extension-caja-file-info.synopsis" class="shortcut">Top</a> +  | + <a href="#libcaja-extension-caja-file-info.description" class="shortcut">Description</a> +  | + <a href="#libcaja-extension-caja-file-info.object-hierarchy" class="shortcut">Object Hierarchy</a> +  | + <a href="#libcaja-extension-caja-file-info.prerequisites" class="shortcut">Prerequisites</a> +</td></tr> +</table> +<div class="refentry" title="caja-file-info"> +<a name="libcaja-extension-caja-file-info"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libcaja-extension-caja-file-info.top_of_page"></a>caja-file-info</span></h2> +<p>caja-file-info</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="libcaja-extension-caja-file-info.synopsis"></a><h2>Synopsis</h2> +<a name="CajaFileInfo"></a><pre class="synopsis">#define <a class="link" href="libcaja-extension-caja-file-info.html#CAJA-FILE-DEFINED:CAPS" title="CAJA_FILE_DEFINED">CAJA_FILE_DEFINED</a> +typedef <a class="link" href="libcaja-extension-caja-file-info.html#CajaFile" title="CajaFile">CajaFile</a>; +typedef <a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo">CajaFileInfo</a>; + <a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfoIface" title="CajaFileInfoIface">CajaFileInfoIface</a>; +<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-list-copy" title="caja_file_info_list_copy ()">caja_file_info_list_copy</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *files</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-list-free" title="caja_file_info_list_free ()">caja_file_info_list_free</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *files</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-is-gone" title="caja_file_info_is_gone ()">caja_file_info_is_gone</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>); +<a href="http://library.gnome.org/devel/gio/unstable/GFileInfo.html#GFileType"><span class="returnvalue">GFileType</span></a> <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-get-file-type" title="caja_file_info_get_file_type ()">caja_file_info_get_file_type</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>); +<a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="returnvalue">GFile</span></a> * <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-get-location" title="caja_file_info_get_location ()">caja_file_info_get_location</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-get-name" title="caja_file_info_get_name ()">caja_file_info_get_name</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-get-uri" title="caja_file_info_get_uri ()">caja_file_info_get_uri</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-get-activation-uri" title="caja_file_info_get_activation_uri ()">caja_file_info_get_activation_uri</a> + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>); +<a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="returnvalue">GFile</span></a> * <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-get-parent-location" title="caja_file_info_get_parent_location ()">caja_file_info_get_parent_location</a> + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-get-parent-uri" title="caja_file_info_get_parent_uri ()">caja_file_info_get_parent_uri</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>); +<a href="http://library.gnome.org/devel/gio/unstable/GMount.html"><span class="returnvalue">GMount</span></a> * <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-get-mount" title="caja_file_info_get_mount ()">caja_file_info_get_mount</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-get-uri-scheme" title="caja_file_info_get_uri_scheme ()">caja_file_info_get_uri_scheme</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>); +<a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="returnvalue">CajaFileInfo</span></a>* <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-get-parent-info" title="caja_file_info_get_parent_info ()">caja_file_info_get_parent_info</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-get-mime-type" title="caja_file_info_get_mime_type ()">caja_file_info_get_mime_type</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-is-mime-type" title="caja_file_info_is_mime_type ()">caja_file_info_is_mime_type</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-is-directory" title="caja_file_info_is_directory ()">caja_file_info_is_directory</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-can-write" title="caja_file_info_can_write ()">caja_file_info_can_write</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-add-emblem" title="caja_file_info_add_emblem ()">caja_file_info_add_emblem</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *emblem_name</code></em>); +<span class="returnvalue">char</span> * <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-get-string-attribute" title="caja_file_info_get_string_attribute ()">caja_file_info_get_string_attribute</a> + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *attribute_name</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-add-string-attribute" title="caja_file_info_add_string_attribute ()">caja_file_info_add_string_attribute</a> + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *attribute_name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libcaja-extension-caja-file-info.html#caja-file-info-invalidate-extension-info" title="caja_file_info_invalidate_extension_info ()">caja_file_info_invalidate_extension_info</a> + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>); +</pre> +</div> +<div class="refsect1" title="Object Hierarchy"> +<a name="libcaja-extension-caja-file-info.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GInterface + +----CajaFileInfo +</pre> +</div> +<div class="refsect1" title="Prerequisites"> +<a name="libcaja-extension-caja-file-info.prerequisites"></a><h2>Prerequisites</h2> +<p> +CajaFileInfo requires + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p> +</div> +<div class="refsect1" title="Description"> +<a name="libcaja-extension-caja-file-info.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="libcaja-extension-caja-file-info.details"></a><h2>Details</h2> +<div class="refsect2" title="CAJA_FILE_DEFINED"> +<a name="CAJA-FILE-DEFINED:CAPS"></a><h3>CAJA_FILE_DEFINED</h3> +<pre class="programlisting">#define CAJA_FILE_DEFINED +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="CajaFile"> +<a name="CajaFile"></a><h3>CajaFile</h3> +<pre class="programlisting">typedef struct CajaFile CajaFile; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="CajaFileInfo"> +<a name="CajaFileInfo"></a><h3>CajaFileInfo</h3> +<pre class="programlisting">typedef CajaFile CajaFileInfo; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="CajaFileInfoIface"> +<a name="CajaFileInfoIface"></a><h3>CajaFileInfoIface</h3> +<pre class="programlisting">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; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="caja_file_info_list_copy ()"> +<a name="caja-file-info-list-copy"></a><h3>caja_file_info_list_copy ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * caja_file_info_list_copy (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *files</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>files</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_list_free ()"> +<a name="caja-file-info-list-free"></a><h3>caja_file_info_list_free ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> caja_file_info_list_free (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *files</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>files</code></em> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_is_gone ()"> +<a name="caja-file-info-is-gone"></a><h3>caja_file_info_is_gone ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> caja_file_info_is_gone (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_get_file_type ()"> +<a name="caja-file-info-get-file-type"></a><h3>caja_file_info_get_file_type ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gio/unstable/GFileInfo.html#GFileType"><span class="returnvalue">GFileType</span></a> caja_file_info_get_file_type (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_get_location ()"> +<a name="caja-file-info-get-location"></a><h3>caja_file_info_get_location ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="returnvalue">GFile</span></a> * caja_file_info_get_location (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_get_name ()"> +<a name="caja-file-info-get-name"></a><h3>caja_file_info_get_name ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * caja_file_info_get_name (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_get_uri ()"> +<a name="caja-file-info-get-uri"></a><h3>caja_file_info_get_uri ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * caja_file_info_get_uri (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_get_activation_uri ()"> +<a name="caja-file-info-get-activation-uri"></a><h3>caja_file_info_get_activation_uri ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * caja_file_info_get_activation_uri + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_get_parent_location ()"> +<a name="caja-file-info-get-parent-location"></a><h3>caja_file_info_get_parent_location ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gio/unstable/GFile.html"><span class="returnvalue">GFile</span></a> * caja_file_info_get_parent_location + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_get_parent_uri ()"> +<a name="caja-file-info-get-parent-uri"></a><h3>caja_file_info_get_parent_uri ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * caja_file_info_get_parent_uri (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_get_mount ()"> +<a name="caja-file-info-get-mount"></a><h3>caja_file_info_get_mount ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gio/unstable/GMount.html"><span class="returnvalue">GMount</span></a> * caja_file_info_get_mount (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_get_uri_scheme ()"> +<a name="caja-file-info-get-uri-scheme"></a><h3>caja_file_info_get_uri_scheme ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * caja_file_info_get_uri_scheme (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_get_parent_info ()"> +<a name="caja-file-info-get-parent-info"></a><h3>caja_file_info_get_parent_info ()</h3> +<pre class="programlisting"><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="returnvalue">CajaFileInfo</span></a>* caja_file_info_get_parent_info (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_get_mime_type ()"> +<a name="caja-file-info-get-mime-type"></a><h3>caja_file_info_get_mime_type ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * caja_file_info_get_mime_type (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_is_mime_type ()"> +<a name="caja-file-info-is-mime-type"></a><h3>caja_file_info_is_mime_type ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> caja_file_info_is_mime_type (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_is_directory ()"> +<a name="caja-file-info-is-directory"></a><h3>caja_file_info_is_directory ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> caja_file_info_is_directory (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_can_write ()"> +<a name="caja-file-info-can-write"></a><h3>caja_file_info_can_write ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> caja_file_info_can_write (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_add_emblem ()"> +<a name="caja-file-info-add-emblem"></a><h3>caja_file_info_add_emblem ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> caja_file_info_add_emblem (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *emblem_name</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>emblem_name</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_get_string_attribute ()"> +<a name="caja-file-info-get-string-attribute"></a><h3>caja_file_info_get_string_attribute ()</h3> +<pre class="programlisting"><span class="returnvalue">char</span> * caja_file_info_get_string_attribute + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *attribute_name</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>attribute_name</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_add_string_attribute ()"> +<a name="caja-file-info-add-string-attribute"></a><h3>caja_file_info_add_string_attribute ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> caja_file_info_add_string_attribute + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *attribute_name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>attribute_name</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_file_info_invalidate_extension_info ()"> +<a name="caja-file-info-invalidate-extension-info"></a><h3>caja_file_info_invalidate_extension_info ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> caja_file_info_invalidate_extension_info + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html> 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>caja-info-provider</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Caja Extension Reference Manual"> +<link rel="up" href="ch01.html" title="Extension Interfaces"> +<link rel="prev" href="libcaja-extension-caja-file-info.html" title="caja-file-info"> +<link rel="next" href="libcaja-extension-caja-location-widget-provider.html" title="caja-location-widget-provider"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="libcaja-extension-caja-file-info.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Caja Extension Reference Manual</th> +<td><a accesskey="n" href="libcaja-extension-caja-location-widget-provider.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#libcaja-extension-caja-info-provider.synopsis" class="shortcut">Top</a> +  | + <a href="#libcaja-extension-caja-info-provider.description" class="shortcut">Description</a> +  | + <a href="#libcaja-extension-caja-info-provider.object-hierarchy" class="shortcut">Object Hierarchy</a> +  | + <a href="#libcaja-extension-caja-info-provider.prerequisites" class="shortcut">Prerequisites</a> +</td></tr> +</table> +<div class="refentry" title="caja-info-provider"> +<a name="libcaja-extension-caja-info-provider"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libcaja-extension-caja-info-provider.top_of_page"></a>caja-info-provider</span></h2> +<p>caja-info-provider</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="libcaja-extension-caja-info-provider.synopsis"></a><h2>Synopsis</h2> +<a name="CajaInfoProvider"></a><pre class="synopsis"> <a class="link" href="libcaja-extension-caja-info-provider.html#CajaInfoProvider-struct" title="CajaInfoProvider">CajaInfoProvider</a>; + <a class="link" href="libcaja-extension-caja-info-provider.html#CajaInfoProviderIface" title="CajaInfoProviderIface">CajaInfoProviderIface</a>; +<span class="returnvalue">void</span> (<a class="link" href="libcaja-extension-caja-info-provider.html#CajaInfoProviderUpdateComplete" title="CajaInfoProviderUpdateComplete ()">*CajaInfoProviderUpdateComplete</a>) + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-info-provider.html#CajaInfoProvider"><span class="type">CajaInfoProvider</span></a> *provider</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-extension-types.html#CajaOperationHandle" title="CajaOperationHandle"><span class="type">CajaOperationHandle</span></a> *handle</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-extension-types.html#CajaOperationResult" title="enum CajaOperationResult"><span class="type">CajaOperationResult</span></a> result</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>); +<a class="link" href="libcaja-extension-caja-extension-types.html#CajaOperationResult" title="enum CajaOperationResult"><span class="returnvalue">CajaOperationResult</span></a> <a class="link" href="libcaja-extension-caja-info-provider.html#caja-info-provider-update-file-info" title="caja_info_provider_update_file_info ()">caja_info_provider_update_file_info</a> + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-info-provider.html#CajaInfoProvider"><span class="type">CajaInfoProvider</span></a> *provider</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *update_complete</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-extension-types.html#CajaOperationHandle" title="CajaOperationHandle"><span class="type">CajaOperationHandle</span></a> **handle</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libcaja-extension-caja-info-provider.html#caja-info-provider-cancel-update" title="caja_info_provider_cancel_update ()">caja_info_provider_cancel_update</a> + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-info-provider.html#CajaInfoProvider"><span class="type">CajaInfoProvider</span></a> *provider</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-extension-types.html#CajaOperationHandle" title="CajaOperationHandle"><span class="type">CajaOperationHandle</span></a> *handle</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libcaja-extension-caja-info-provider.html#caja-info-provider-update-complete-invoke" title="caja_info_provider_update_complete_invoke ()">caja_info_provider_update_complete_invoke</a> + (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *update_complete</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-info-provider.html#CajaInfoProvider"><span class="type">CajaInfoProvider</span></a> *provider</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-extension-types.html#CajaOperationHandle" title="CajaOperationHandle"><span class="type">CajaOperationHandle</span></a> *handle</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-extension-types.html#CajaOperationResult" title="enum CajaOperationResult"><span class="type">CajaOperationResult</span></a> result</code></em>); +</pre> +</div> +<div class="refsect1" title="Object Hierarchy"> +<a name="libcaja-extension-caja-info-provider.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GInterface + +----CajaInfoProvider +</pre> +</div> +<div class="refsect1" title="Prerequisites"> +<a name="libcaja-extension-caja-info-provider.prerequisites"></a><h2>Prerequisites</h2> +<p> +CajaInfoProvider requires + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p> +</div> +<div class="refsect1" title="Description"> +<a name="libcaja-extension-caja-info-provider.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="libcaja-extension-caja-info-provider.details"></a><h2>Details</h2> +<div class="refsect2" title="CajaInfoProvider"> +<a name="CajaInfoProvider-struct"></a><h3>CajaInfoProvider</h3> +<pre class="programlisting">typedef struct _CajaInfoProvider CajaInfoProvider;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="CajaInfoProviderIface"> +<a name="CajaInfoProviderIface"></a><h3>CajaInfoProviderIface</h3> +<pre class="programlisting">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; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="CajaInfoProviderUpdateComplete ()"> +<a name="CajaInfoProviderUpdateComplete"></a><h3>CajaInfoProviderUpdateComplete ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> (*CajaInfoProviderUpdateComplete) + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-info-provider.html#CajaInfoProvider"><span class="type">CajaInfoProvider</span></a> *provider</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-extension-types.html#CajaOperationHandle" title="CajaOperationHandle"><span class="type">CajaOperationHandle</span></a> *handle</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-extension-types.html#CajaOperationResult" title="enum CajaOperationResult"><span class="type">CajaOperationResult</span></a> result</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_info_provider_update_file_info ()"> +<a name="caja-info-provider-update-file-info"></a><h3>caja_info_provider_update_file_info ()</h3> +<pre class="programlisting"><a class="link" href="libcaja-extension-caja-extension-types.html#CajaOperationResult" title="enum CajaOperationResult"><span class="returnvalue">CajaOperationResult</span></a> caja_info_provider_update_file_info + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-info-provider.html#CajaInfoProvider"><span class="type">CajaInfoProvider</span></a> *provider</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *file</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *update_complete</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-extension-types.html#CajaOperationHandle" title="CajaOperationHandle"><span class="type">CajaOperationHandle</span></a> **handle</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>update_complete</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_info_provider_cancel_update ()"> +<a name="caja-info-provider-cancel-update"></a><h3>caja_info_provider_cancel_update ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> caja_info_provider_cancel_update + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-info-provider.html#CajaInfoProvider"><span class="type">CajaInfoProvider</span></a> *provider</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-extension-types.html#CajaOperationHandle" title="CajaOperationHandle"><span class="type">CajaOperationHandle</span></a> *handle</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_info_provider_update_complete_invoke ()"> +<a name="caja-info-provider-update-complete-invoke"></a><h3>caja_info_provider_update_complete_invoke ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> caja_info_provider_update_complete_invoke + (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Closures.html#GClosure"><span class="type">GClosure</span></a> *update_complete</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-info-provider.html#CajaInfoProvider"><span class="type">CajaInfoProvider</span></a> *provider</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-extension-types.html#CajaOperationHandle" title="CajaOperationHandle"><span class="type">CajaOperationHandle</span></a> *handle</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-extension-types.html#CajaOperationResult" title="enum CajaOperationResult"><span class="type">CajaOperationResult</span></a> result</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>update_complete</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html> 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>caja-location-widget-provider</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Caja Extension Reference Manual"> +<link rel="up" href="ch01.html" title="Extension Interfaces"> +<link rel="prev" href="libcaja-extension-caja-info-provider.html" title="caja-info-provider"> +<link rel="next" href="libcaja-extension-caja-menu-provider.html" title="caja-menu-provider"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="libcaja-extension-caja-info-provider.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Caja Extension Reference Manual</th> +<td><a accesskey="n" href="libcaja-extension-caja-menu-provider.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#libcaja-extension-caja-location-widget-provider.synopsis" class="shortcut">Top</a> +  | + <a href="#libcaja-extension-caja-location-widget-provider.description" class="shortcut">Description</a> +  | + <a href="#libcaja-extension-caja-location-widget-provider.object-hierarchy" class="shortcut">Object Hierarchy</a> +  | + <a href="#libcaja-extension-caja-location-widget-provider.prerequisites" class="shortcut">Prerequisites</a> +</td></tr> +</table> +<div class="refentry" title="caja-location-widget-provider"> +<a name="libcaja-extension-caja-location-widget-provider"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libcaja-extension-caja-location-widget-provider.top_of_page"></a>caja-location-widget-provider</span></h2> +<p>caja-location-widget-provider</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="libcaja-extension-caja-location-widget-provider.synopsis"></a><h2>Synopsis</h2> +<a name="CajaLocationWidgetProvider"></a><pre class="synopsis"> <a class="link" href="libcaja-extension-caja-location-widget-provider.html#CajaLocationWidgetProvider-struct" title="CajaLocationWidgetProvider">CajaLocationWidgetProvider</a>; + <a class="link" href="libcaja-extension-caja-location-widget-provider.html#CajaLocationWidgetProviderIface" title="CajaLocationWidgetProviderIface">CajaLocationWidgetProviderIface</a>; +<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="libcaja-extension-caja-location-widget-provider.html#caja-location-widget-provider-get-widget" title="caja_location_widget_provider_get_widget ()">caja_location_widget_provider_get_widget</a> + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-location-widget-provider.html#CajaLocationWidgetProvider"><span class="type">CajaLocationWidgetProvider</span></a> *provider</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *window</code></em>); +</pre> +</div> +<div class="refsect1" title="Object Hierarchy"> +<a name="libcaja-extension-caja-location-widget-provider.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GInterface + +----CajaLocationWidgetProvider +</pre> +</div> +<div class="refsect1" title="Prerequisites"> +<a name="libcaja-extension-caja-location-widget-provider.prerequisites"></a><h2>Prerequisites</h2> +<p> +CajaLocationWidgetProvider requires + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p> +</div> +<div class="refsect1" title="Description"> +<a name="libcaja-extension-caja-location-widget-provider.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="libcaja-extension-caja-location-widget-provider.details"></a><h2>Details</h2> +<div class="refsect2" title="CajaLocationWidgetProvider"> +<a name="CajaLocationWidgetProvider-struct"></a><h3>CajaLocationWidgetProvider</h3> +<pre class="programlisting">typedef struct _CajaLocationWidgetProvider CajaLocationWidgetProvider;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="CajaLocationWidgetProviderIface"> +<a name="CajaLocationWidgetProviderIface"></a><h3>CajaLocationWidgetProviderIface</h3> +<pre class="programlisting">typedef struct { + GTypeInterface g_iface; + + GtkWidget * (*get_widget) (CajaLocationWidgetProvider *provider, + const char *uri, + GtkWidget *window); +} CajaLocationWidgetProviderIface; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="caja_location_widget_provider_get_widget ()"> +<a name="caja-location-widget-provider-get-widget"></a><h3>caja_location_widget_provider_get_widget ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * caja_location_widget_provider_get_widget + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-location-widget-provider.html#CajaLocationWidgetProvider"><span class="type">CajaLocationWidgetProvider</span></a> *provider</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *window</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html> 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>caja-menu-provider</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Caja Extension Reference Manual"> +<link rel="up" href="ch01.html" title="Extension Interfaces"> +<link rel="prev" href="libcaja-extension-caja-location-widget-provider.html" title="caja-location-widget-provider"> +<link rel="next" href="libcaja-extension-caja-menu.html" title="CajaMenuItem"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="libcaja-extension-caja-location-widget-provider.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Caja Extension Reference Manual</th> +<td><a accesskey="n" href="libcaja-extension-caja-menu.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#libcaja-extension-caja-menu-provider.synopsis" class="shortcut">Top</a> +  | + <a href="#libcaja-extension-caja-menu-provider.description" class="shortcut">Description</a> +  | + <a href="#libcaja-extension-caja-menu-provider.object-hierarchy" class="shortcut">Object Hierarchy</a> +  | + <a href="#libcaja-extension-caja-menu-provider.prerequisites" class="shortcut">Prerequisites</a> +  | + <a href="#libcaja-extension-caja-menu-provider.signals" class="shortcut">Signals</a> +</td></tr> +</table> +<div class="refentry" title="caja-menu-provider"> +<a name="libcaja-extension-caja-menu-provider"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libcaja-extension-caja-menu-provider.top_of_page"></a>caja-menu-provider</span></h2> +<p>caja-menu-provider</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="libcaja-extension-caja-menu-provider.synopsis"></a><h2>Synopsis</h2> +<a name="CajaMenuProvider"></a><pre class="synopsis"> <a class="link" href="libcaja-extension-caja-menu-provider.html#CajaMenuProvider-struct" title="CajaMenuProvider">CajaMenuProvider</a>; + <a class="link" href="libcaja-extension-caja-menu-provider.html#CajaMenuProviderIface" title="CajaMenuProviderIface">CajaMenuProviderIface</a>; +<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * <a class="link" href="libcaja-extension-caja-menu-provider.html#caja-menu-provider-get-file-items" title="caja_menu_provider_get_file_items ()">caja_menu_provider_get_file_items</a> + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu-provider.html#CajaMenuProvider"><span class="type">CajaMenuProvider</span></a> *provider</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *window</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *files</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * <a class="link" href="libcaja-extension-caja-menu-provider.html#caja-menu-provider-get-background-items" title="caja_menu_provider_get_background_items ()">caja_menu_provider_get_background_items</a> + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu-provider.html#CajaMenuProvider"><span class="type">CajaMenuProvider</span></a> *provider</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *window</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *current_folder</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * <a class="link" href="libcaja-extension-caja-menu-provider.html#caja-menu-provider-get-toolbar-items" title="caja_menu_provider_get_toolbar_items ()">caja_menu_provider_get_toolbar_items</a> + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu-provider.html#CajaMenuProvider"><span class="type">CajaMenuProvider</span></a> *provider</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *window</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *current_folder</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libcaja-extension-caja-menu-provider.html#caja-menu-provider-emit-items-updated-signal" title="caja_menu_provider_emit_items_updated_signal ()">caja_menu_provider_emit_items_updated_signal</a> + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu-provider.html#CajaMenuProvider"><span class="type">CajaMenuProvider</span></a> *provider</code></em>); +</pre> +</div> +<div class="refsect1" title="Object Hierarchy"> +<a name="libcaja-extension-caja-menu-provider.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GInterface + +----CajaMenuProvider +</pre> +</div> +<div class="refsect1" title="Prerequisites"> +<a name="libcaja-extension-caja-menu-provider.prerequisites"></a><h2>Prerequisites</h2> +<p> +CajaMenuProvider requires + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p> +</div> +<div class="refsect1" title="Signals"> +<a name="libcaja-extension-caja-menu-provider.signals"></a><h2>Signals</h2> +<pre class="synopsis"> + "<a class="link" href="libcaja-extension-caja-menu-provider.html#CajaMenuProvider-items-updated" title='The "items-updated" signal'>items-updated</a>" : Run Last +</pre> +</div> +<div class="refsect1" title="Description"> +<a name="libcaja-extension-caja-menu-provider.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="libcaja-extension-caja-menu-provider.details"></a><h2>Details</h2> +<div class="refsect2" title="CajaMenuProvider"> +<a name="CajaMenuProvider-struct"></a><h3>CajaMenuProvider</h3> +<pre class="programlisting">typedef struct _CajaMenuProvider CajaMenuProvider;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="CajaMenuProviderIface"> +<a name="CajaMenuProviderIface"></a><h3>CajaMenuProviderIface</h3> +<pre class="programlisting">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; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="caja_menu_provider_get_file_items ()"> +<a name="caja-menu-provider-get-file-items"></a><h3>caja_menu_provider_get_file_items ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * caja_menu_provider_get_file_items + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu-provider.html#CajaMenuProvider"><span class="type">CajaMenuProvider</span></a> *provider</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *window</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *files</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>files</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_menu_provider_get_background_items ()"> +<a name="caja-menu-provider-get-background-items"></a><h3>caja_menu_provider_get_background_items ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * caja_menu_provider_get_background_items + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu-provider.html#CajaMenuProvider"><span class="type">CajaMenuProvider</span></a> *provider</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *window</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *current_folder</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>current_folder</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_menu_provider_get_toolbar_items ()"> +<a name="caja-menu-provider-get-toolbar-items"></a><h3>caja_menu_provider_get_toolbar_items ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * caja_menu_provider_get_toolbar_items + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu-provider.html#CajaMenuProvider"><span class="type">CajaMenuProvider</span></a> *provider</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *window</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> *current_folder</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>current_folder</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_menu_provider_emit_items_updated_signal ()"> +<a name="caja-menu-provider-emit-items-updated-signal"></a><h3>caja_menu_provider_emit_items_updated_signal ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> caja_menu_provider_emit_items_updated_signal + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu-provider.html#CajaMenuProvider"><span class="type">CajaMenuProvider</span></a> *provider</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +</div> +<div class="refsect1" title="Signal Details"> +<a name="libcaja-extension-caja-menu-provider.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2" title='The "items-updated" signal'> +<a name="CajaMenuProvider-items-updated"></a><h3>The <code class="literal">"items-updated"</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="libcaja-extension-caja-menu-provider.html#CajaMenuProvider"><span class="type">CajaMenuProvider</span></a> *cajamenuprovider, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cajamenuprovider</code></em> :</span></p></td> +<td>the object which received the signal. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data set when the signal handler was connected.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html> 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>CajaMenuItem</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Caja Extension Reference Manual"> +<link rel="up" href="ch01.html" title="Extension Interfaces"> +<link rel="prev" href="libcaja-extension-caja-menu-provider.html" title="caja-menu-provider"> +<link rel="next" href="libcaja-extension-caja-property-page-provider.html" title="caja-property-page-provider"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="libcaja-extension-caja-menu-provider.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Caja Extension Reference Manual</th> +<td><a accesskey="n" href="libcaja-extension-caja-property-page-provider.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#libcaja-extension-caja-menu.synopsis" class="shortcut">Top</a> +  | + <a href="#libcaja-extension-caja-menu.description" class="shortcut">Description</a> +  | + <a href="#libcaja-extension-caja-menu.object-hierarchy" class="shortcut">Object Hierarchy</a> +  | + <a href="#libcaja-extension-caja-menu.properties" class="shortcut">Properties</a> +  | + <a href="#libcaja-extension-caja-menu.signals" class="shortcut">Signals</a> +</td></tr> +</table> +<div class="refentry" title="CajaMenuItem"> +<a name="libcaja-extension-caja-menu"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libcaja-extension-caja-menu.top_of_page"></a>CajaMenuItem</span></h2> +<p>CajaMenuItem</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="libcaja-extension-caja-menu.synopsis"></a><h2>Synopsis</h2> +<a name="CajaMenu"></a><a name="CajaMenuItem"></a><pre class="synopsis">#define <a class="link" href="libcaja-extension-caja-menu.html#CAJA-TYPE-MENU-ITEM:CAPS" title="CAJA_TYPE_MENU_ITEM">CAJA_TYPE_MENU_ITEM</a> +#define <a class="link" href="libcaja-extension-caja-menu.html#CAJA-MENU-ITEM:CAPS" title="CAJA_MENU_ITEM()">CAJA_MENU_ITEM</a> (obj) +#define <a class="link" href="libcaja-extension-caja-menu.html#CAJA-MENU-ITEM-CLASS:CAPS" title="CAJA_MENU_ITEM_CLASS()">CAJA_MENU_ITEM_CLASS</a> (klass) +#define <a class="link" href="libcaja-extension-caja-menu.html#CAJA-MENU-IS-ITEM:CAPS" title="CAJA_MENU_IS_ITEM()">CAJA_MENU_IS_ITEM</a> (obj) +#define <a class="link" href="libcaja-extension-caja-menu.html#CAJA-MENU-IS-ITEM-CLASS:CAPS" title="CAJA_MENU_IS_ITEM_CLASS()">CAJA_MENU_IS_ITEM_CLASS</a> (klass) +#define <a class="link" href="libcaja-extension-caja-menu.html#CAJA-MENU-ITEM-GET-CLASS:CAPS" title="CAJA_MENU_ITEM_GET_CLASS()">CAJA_MENU_ITEM_GET_CLASS</a> (obj) + <a class="link" href="libcaja-extension-caja-menu.html#CajaMenuPrivate" title="CajaMenuPrivate">CajaMenuPrivate</a>; + <a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItemDetails" title="CajaMenuItemDetails">CajaMenuItemDetails</a>; + <a class="link" href="libcaja-extension-caja-menu.html#CajaMenu-struct" title="CajaMenu">CajaMenu</a>; + <a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem-struct" title="CajaMenuItem">CajaMenuItem</a>; +<a class="link" href="libcaja-extension-caja-menu.html#CajaMenu"><span class="returnvalue">CajaMenu</span></a> * <a class="link" href="libcaja-extension-caja-menu.html#caja-menu-new" title="caja_menu_new ()">caja_menu_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<span class="returnvalue">void</span> <a class="link" href="libcaja-extension-caja-menu.html#caja-menu-append-item" title="caja_menu_append_item ()">caja_menu_append_item</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu.html#CajaMenu"><span class="type">CajaMenu</span></a> *menu</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem"><span class="type">CajaMenuItem</span></a> *item</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a>* <a class="link" href="libcaja-extension-caja-menu.html#caja-menu-get-items" title="caja_menu_get_items ()">caja_menu_get_items</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu.html#CajaMenu"><span class="type">CajaMenu</span></a> *menu</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libcaja-extension-caja-menu.html#caja-menu-item-list-free" title="caja_menu_item_list_free ()">caja_menu_item_list_free</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *item_list</code></em>); +<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> <a class="link" href="libcaja-extension-caja-menu.html#caja-menu-item-get-type" title="caja_menu_item_get_type ()">caja_menu_item_get_type</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem"><span class="returnvalue">CajaMenuItem</span></a> * <a class="link" href="libcaja-extension-caja-menu.html#caja-menu-item-new" title="caja_menu_item_new ()">caja_menu_item_new</a> (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *label</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *tip</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *icon</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libcaja-extension-caja-menu.html#caja-menu-item-activate" title="caja_menu_item_activate ()">caja_menu_item_activate</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem"><span class="type">CajaMenuItem</span></a> *item</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libcaja-extension-caja-menu.html#caja-menu-item-set-submenu" title="caja_menu_item_set_submenu ()">caja_menu_item_set_submenu</a> (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem"><span class="type">CajaMenuItem</span></a> *item</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu.html#CajaMenu"><span class="type">CajaMenu</span></a> *menu</code></em>); +</pre> +</div> +<div class="refsect1" title="Object Hierarchy"> +<a name="libcaja-extension-caja-menu.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----CajaMenu +</pre> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----CajaMenuItem +</pre> +</div> +<div class="refsect1" title="Properties"> +<a name="libcaja-extension-caja-menu.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem--icon" title='The "icon" property'>icon</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem--label" title='The "label" property'>label</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem--menu" title='The "menu" property'>menu</a>" <a class="link" href="libcaja-extension-caja-menu.html#CajaMenu"><span class="type">CajaMenu</span></a>* : Read / Write + "<a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem--name" title='The "name" property'>name</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only + "<a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem--priority" title='The "priority" property'>priority</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write + "<a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem--sensitive" title='The "sensitive" property'>sensitive</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write + "<a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem--tip" title='The "tip" property'>tip</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write +</pre> +</div> +<div class="refsect1" title="Signals"> +<a name="libcaja-extension-caja-menu.signals"></a><h2>Signals</h2> +<pre class="synopsis"> + "<a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem-activate" title='The "activate" signal'>activate</a>" : Run Last +</pre> +</div> +<div class="refsect1" title="Description"> +<a name="libcaja-extension-caja-menu.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="libcaja-extension-caja-menu.details"></a><h2>Details</h2> +<div class="refsect2" title="CAJA_TYPE_MENU_ITEM"> +<a name="CAJA-TYPE-MENU-ITEM:CAPS"></a><h3>CAJA_TYPE_MENU_ITEM</h3> +<pre class="programlisting">#define CAJA_TYPE_MENU_ITEM (caja_menu_item_get_type()) +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="CAJA_MENU_ITEM()"> +<a name="CAJA-MENU-ITEM:CAPS"></a><h3>CAJA_MENU_ITEM()</h3> +<pre class="programlisting">#define CAJA_MENU_ITEM(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CAJA_TYPE_MENU_ITEM, CajaMenuItem)) +</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="CAJA_MENU_ITEM_CLASS()"> +<a name="CAJA-MENU-ITEM-CLASS:CAPS"></a><h3>CAJA_MENU_ITEM_CLASS()</h3> +<pre class="programlisting">#define CAJA_MENU_ITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CAJA_TYPE_MENU_ITEM, CajaMenuItemClass)) +</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="CAJA_MENU_IS_ITEM()"> +<a name="CAJA-MENU-IS-ITEM:CAPS"></a><h3>CAJA_MENU_IS_ITEM()</h3> +<pre class="programlisting">#define CAJA_MENU_IS_ITEM(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CAJA_TYPE_MENU_ITEM)) +</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="CAJA_MENU_IS_ITEM_CLASS()"> +<a name="CAJA-MENU-IS-ITEM-CLASS:CAPS"></a><h3>CAJA_MENU_IS_ITEM_CLASS()</h3> +<pre class="programlisting">#define CAJA_MENU_IS_ITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), CAJA_TYPE_MENU_ITEM)) +</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>klass</code></em> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="CAJA_MENU_ITEM_GET_CLASS()"> +<a name="CAJA-MENU-ITEM-GET-CLASS:CAPS"></a><h3>CAJA_MENU_ITEM_GET_CLASS()</h3> +<pre class="programlisting">#define CAJA_MENU_ITEM_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), CAJA_TYPE_MENU_ITEM, CajaMenuItemClass)) +</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="CajaMenuPrivate"> +<a name="CajaMenuPrivate"></a><h3>CajaMenuPrivate</h3> +<pre class="programlisting">typedef struct _CajaMenuPrivate CajaMenuPrivate;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="CajaMenuItemDetails"> +<a name="CajaMenuItemDetails"></a><h3>CajaMenuItemDetails</h3> +<pre class="programlisting">typedef struct _CajaMenuItemDetails CajaMenuItemDetails;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="CajaMenu"> +<a name="CajaMenu-struct"></a><h3>CajaMenu</h3> +<pre class="programlisting">typedef struct _CajaMenu CajaMenu;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="CajaMenuItem"> +<a name="CajaMenuItem-struct"></a><h3>CajaMenuItem</h3> +<pre class="programlisting">typedef struct _CajaMenuItem CajaMenuItem;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="caja_menu_new ()"> +<a name="caja-menu-new"></a><h3>caja_menu_new ()</h3> +<pre class="programlisting"><a class="link" href="libcaja-extension-caja-menu.html#CajaMenu"><span class="returnvalue">CajaMenu</span></a> * caja_menu_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_menu_append_item ()"> +<a name="caja-menu-append-item"></a><h3>caja_menu_append_item ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> caja_menu_append_item (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu.html#CajaMenu"><span class="type">CajaMenu</span></a> *menu</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem"><span class="type">CajaMenuItem</span></a> *item</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>menu</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_menu_get_items ()"> +<a name="caja-menu-get-items"></a><h3>caja_menu_get_items ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a>* caja_menu_get_items (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu.html#CajaMenu"><span class="type">CajaMenu</span></a> *menu</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>menu</code></em> :</span></p></td> +<td> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_menu_item_list_free ()"> +<a name="caja-menu-item-list-free"></a><h3>caja_menu_item_list_free ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> caja_menu_item_list_free (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *item_list</code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>item_list</code></em> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_menu_item_get_type ()"> +<a name="caja-menu-item-get-type"></a><h3>caja_menu_item_get_type ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a> caja_menu_item_get_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_menu_item_new ()"> +<a name="caja-menu-item-new"></a><h3>caja_menu_item_new ()</h3> +<pre class="programlisting"><a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem"><span class="returnvalue">CajaMenuItem</span></a> * caja_menu_item_new (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *label</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *tip</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *icon</code></em>);</pre> +<p> +Creates a new menu item that can be added to the toolbar or to a contextual menu. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>the identifier for the menu item +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td> +<td>the user-visible label of the menu item +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>tip</code></em> :</span></p></td> +<td>the tooltip of the menu item +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td> +<td>the name of the icon to display in the menu item +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> a newly create <a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem"><span class="type">CajaMenuItem</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_menu_item_activate ()"> +<a name="caja-menu-item-activate"></a><h3>caja_menu_item_activate ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> caja_menu_item_activate (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem"><span class="type">CajaMenuItem</span></a> *item</code></em>);</pre> +<p> +emits the activate signal. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody><tr> +<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td> +<td>pointer to a <a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem"><span class="type">CajaMenuItem</span></a> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2" title="caja_menu_item_set_submenu ()"> +<a name="caja-menu-item-set-submenu"></a><h3>caja_menu_item_set_submenu ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> caja_menu_item_set_submenu (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem"><span class="type">CajaMenuItem</span></a> *item</code></em>, + <em class="parameter"><code><a class="link" href="libcaja-extension-caja-menu.html#CajaMenu"><span class="type">CajaMenu</span></a> *menu</code></em>);</pre> +<p> +Attachs a menu to the given <a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem"><span class="type">CajaMenuItem</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td> +<td>pointer to a <a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem"><span class="type">CajaMenuItem</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>menu</code></em> :</span></p></td> +<td>pointer to a <a class="link" href="libcaja-extension-caja-menu.html#CajaMenu"><span class="type">CajaMenu</span></a> to attach to the button +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1" title="Property Details"> +<a name="libcaja-extension-caja-menu.property-details"></a><h2>Property Details</h2> +<div class="refsect2" title='The "icon" property'> +<a name="CajaMenuItem--icon"></a><h3>The <code class="literal">"icon"</code> property</h3> +<pre class="programlisting"> "icon" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p>Name of the icon to display in the menu item.</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "label" property'> +<a name="CajaMenuItem--label"></a><h3>The <code class="literal">"label"</code> property</h3> +<pre class="programlisting"> "label" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p>Label to display to the user.</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "menu" property'> +<a name="CajaMenuItem--menu"></a><h3>The <code class="literal">"menu"</code> property</h3> +<pre class="programlisting"> "menu" <a class="link" href="libcaja-extension-caja-menu.html#CajaMenu"><span class="type">CajaMenu</span></a>* : Read / Write</pre> +<p>The menu belonging to this item. May be null.</p> +</div> +<hr> +<div class="refsect2" title='The "name" property'> +<a name="CajaMenuItem--name"></a><h3>The <code class="literal">"name"</code> property</h3> +<pre class="programlisting"> "name" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre> +<p>Name of the item.</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "priority" property'> +<a name="CajaMenuItem--priority"></a><h3>The <code class="literal">"priority"</code> property</h3> +<pre class="programlisting"> "priority" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre> +<p>Show priority text in toolbars.</p> +<p>Default value: TRUE</p> +</div> +<hr> +<div class="refsect2" title='The "sensitive" property'> +<a name="CajaMenuItem--sensitive"></a><h3>The <code class="literal">"sensitive"</code> property</h3> +<pre class="programlisting"> "sensitive" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre> +<p>Whether the menu item is sensitive.</p> +<p>Default value: TRUE</p> +</div> +<hr> +<div class="refsect2" title='The "tip" property'> +<a name="CajaMenuItem--tip"></a><h3>The <code class="literal">"tip"</code> property</h3> +<pre class="programlisting"> "tip" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p>Tooltip for the menu item.</p> +<p>Default value: NULL</p> +</div> +</div> +<div class="refsect1" title="Signal Details"> +<a name="libcaja-extension-caja-menu.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2" title='The "activate" signal'> +<a name="CajaMenuItem-activate"></a><h3>The <code class="literal">"activate"</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="libcaja-extension-caja-menu.html#CajaMenuItem"><span class="type">CajaMenuItem</span></a> *cajamenuitem, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run Last</pre> +<p> +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>cajamenuitem</code></em> :</span></p></td> +<td>the object which received the signal. +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td> +<td>user data set when the signal handler was connected.</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html> 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>caja-property-page-provider</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Caja Extension Reference Manual"> +<link rel="up" href="ch01.html" title="Extension Interfaces"> +<link rel="prev" href="libcaja-extension-caja-menu.html" title="CajaMenuItem"> +<link rel="next" href="libcaja-extension-caja-property-page.html" title="CajaPropertyPage"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="libcaja-extension-caja-menu.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Caja Extension Reference Manual</th> +<td><a accesskey="n" href="libcaja-extension-caja-property-page.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#libcaja-extension-caja-property-page-provider.synopsis" class="shortcut">Top</a> +  | + <a href="#libcaja-extension-caja-property-page-provider.description" class="shortcut">Description</a> +  | + <a href="#libcaja-extension-caja-property-page-provider.object-hierarchy" class="shortcut">Object Hierarchy</a> +  | + <a href="#libcaja-extension-caja-property-page-provider.prerequisites" class="shortcut">Prerequisites</a> +</td></tr> +</table> +<div class="refentry" title="caja-property-page-provider"> +<a name="libcaja-extension-caja-property-page-provider"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libcaja-extension-caja-property-page-provider.top_of_page"></a>caja-property-page-provider</span></h2> +<p>caja-property-page-provider</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="libcaja-extension-caja-property-page-provider.synopsis"></a><h2>Synopsis</h2> +<a name="CajaPropertyPageProvider"></a><pre class="synopsis"> <a class="link" href="libcaja-extension-caja-property-page-provider.html#CajaPropertyPageProvider-struct" title="CajaPropertyPageProvider">CajaPropertyPageProvider</a>; + <a class="link" href="libcaja-extension-caja-property-page-provider.html#CajaPropertyPageProviderIface" title="CajaPropertyPageProviderIface">CajaPropertyPageProviderIface</a>; +<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * <a class="link" href="libcaja-extension-caja-property-page-provider.html#caja-property-page-provider-get-pages" title="caja_property_page_provider_get_pages ()">caja_property_page_provider_get_pages</a> + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-property-page-provider.html#CajaPropertyPageProvider"><span class="type">CajaPropertyPageProvider</span></a> *provider</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *files</code></em>); +</pre> +</div> +<div class="refsect1" title="Object Hierarchy"> +<a name="libcaja-extension-caja-property-page-provider.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GInterface + +----CajaPropertyPageProvider +</pre> +</div> +<div class="refsect1" title="Prerequisites"> +<a name="libcaja-extension-caja-property-page-provider.prerequisites"></a><h2>Prerequisites</h2> +<p> +CajaPropertyPageProvider requires + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p> +</div> +<div class="refsect1" title="Description"> +<a name="libcaja-extension-caja-property-page-provider.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="libcaja-extension-caja-property-page-provider.details"></a><h2>Details</h2> +<div class="refsect2" title="CajaPropertyPageProvider"> +<a name="CajaPropertyPageProvider-struct"></a><h3>CajaPropertyPageProvider</h3> +<pre class="programlisting">typedef struct _CajaPropertyPageProvider CajaPropertyPageProvider;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="CajaPropertyPageProviderIface"> +<a name="CajaPropertyPageProviderIface"></a><h3>CajaPropertyPageProviderIface</h3> +<pre class="programlisting">typedef struct { + GTypeInterface g_iface; + + GList *(*get_pages) (CajaPropertyPageProvider *provider, + GList *files); +} CajaPropertyPageProviderIface; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="caja_property_page_provider_get_pages ()"> +<a name="caja-property-page-provider-get-pages"></a><h3>caja_property_page_provider_get_pages ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * caja_property_page_provider_get_pages + (<em class="parameter"><code><a class="link" href="libcaja-extension-caja-property-page-provider.html#CajaPropertyPageProvider"><span class="type">CajaPropertyPageProvider</span></a> *provider</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *files</code></em>);</pre> +<p> +This function is called by Caja when it wants property page +items from the extension. +</p> +<p> +This function is called in the main thread before a property page +is shown, so it should return quickly. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td> +<td>a <a class="link" href="libcaja-extension-caja-property-page-provider.html#CajaPropertyPageProvider"><span class="type">CajaPropertyPageProvider</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>files</code></em> :</span></p></td> +<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of <a class="link" href="libcaja-extension-caja-file-info.html#CajaFileInfo"><span class="type">CajaFileInfo</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> A <a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of allocated <a class="link" href="libcaja-extension-caja-property-page.html#CajaPropertyPage"><span class="type">CajaPropertyPage</span></a> items. +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html> 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>CajaPropertyPage</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Caja Extension Reference Manual"> +<link rel="up" href="ch01.html" title="Extension Interfaces"> +<link rel="prev" href="libcaja-extension-caja-property-page-provider.html" title="caja-property-page-provider"> +<link rel="next" href="ix01.html" title="Index"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> +<td><a accesskey="p" href="libcaja-extension-caja-property-page-provider.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Caja Extension Reference Manual</th> +<td><a accesskey="n" href="ix01.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#libcaja-extension-caja-property-page.synopsis" class="shortcut">Top</a> +  | + <a href="#libcaja-extension-caja-property-page.description" class="shortcut">Description</a> +  | + <a href="#libcaja-extension-caja-property-page.object-hierarchy" class="shortcut">Object Hierarchy</a> +  | + <a href="#libcaja-extension-caja-property-page.properties" class="shortcut">Properties</a> +</td></tr> +</table> +<div class="refentry" title="CajaPropertyPage"> +<a name="libcaja-extension-caja-property-page"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libcaja-extension-caja-property-page.top_of_page"></a>CajaPropertyPage</span></h2> +<p>CajaPropertyPage</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="libcaja-extension-caja-property-page.synopsis"></a><h2>Synopsis</h2> +<a name="CajaPropertyPage"></a><pre class="synopsis"> <a class="link" href="libcaja-extension-caja-property-page.html#CajaPropertyPageDetails" title="CajaPropertyPageDetails">CajaPropertyPageDetails</a>; + <a class="link" href="libcaja-extension-caja-property-page.html#CajaPropertyPage-struct" title="CajaPropertyPage">CajaPropertyPage</a>; +<a class="link" href="libcaja-extension-caja-property-page.html#CajaPropertyPage"><span class="returnvalue">CajaPropertyPage</span></a> * <a class="link" href="libcaja-extension-caja-property-page.html#caja-property-page-new" title="caja_property_page_new ()">caja_property_page_new</a> (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *label</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *page</code></em>); +</pre> +</div> +<div class="refsect1" title="Object Hierarchy"> +<a name="libcaja-extension-caja-property-page.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + +----CajaPropertyPage +</pre> +</div> +<div class="refsect1" title="Properties"> +<a name="libcaja-extension-caja-property-page.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="libcaja-extension-caja-property-page.html#CajaPropertyPage--label" title='The "label" property'>label</a>" <a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a>* : Read / Write + "<a class="link" href="libcaja-extension-caja-property-page.html#CajaPropertyPage--name" title='The "name" property'>name</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only + "<a class="link" href="libcaja-extension-caja-property-page.html#CajaPropertyPage--page" title='The "page" property'>page</a>" <a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a>* : Read / Write +</pre> +</div> +<div class="refsect1" title="Description"> +<a name="libcaja-extension-caja-property-page.description"></a><h2>Description</h2> +<p> +</p> +</div> +<div class="refsect1" title="Details"> +<a name="libcaja-extension-caja-property-page.details"></a><h2>Details</h2> +<div class="refsect2" title="CajaPropertyPageDetails"> +<a name="CajaPropertyPageDetails"></a><h3>CajaPropertyPageDetails</h3> +<pre class="programlisting">typedef struct _CajaPropertyPageDetails CajaPropertyPageDetails;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="CajaPropertyPage"> +<a name="CajaPropertyPage-struct"></a><h3>CajaPropertyPage</h3> +<pre class="programlisting">typedef struct _CajaPropertyPage CajaPropertyPage;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2" title="caja_property_page_new ()"> +<a name="caja-property-page-new"></a><h3>caja_property_page_new ()</h3> +<pre class="programlisting"><a class="link" href="libcaja-extension-caja-property-page.html#CajaPropertyPage"><span class="returnvalue">CajaPropertyPage</span></a> * caja_property_page_new (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *label</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a> *page</code></em>);</pre> +<p> +Creates a new <a class="link" href="libcaja-extension-caja-property-page.html#CajaPropertyPage"><span class="type">CajaPropertyPage</span></a> from page_widget. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> +<td>the identifier for the property page +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td> +<td>the user-visible label of the property page +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>page</code></em> :</span></p></td> +<td>the property page to display +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> a newly created <a class="link" href="libcaja-extension-caja-property-page.html#CajaPropertyPage"><span class="type">CajaPropertyPage</span></a> +</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1" title="Property Details"> +<a name="libcaja-extension-caja-property-page.property-details"></a><h2>Property Details</h2> +<div class="refsect2" title='The "label" property'> +<a name="CajaPropertyPage--label"></a><h3>The <code class="literal">"label"</code> property</h3> +<pre class="programlisting"> "label" <a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a>* : Read / Write</pre> +<p>Label widget to display in the notebook tab.</p> +</div> +<hr> +<div class="refsect2" title='The "name" property'> +<a name="CajaPropertyPage--name"></a><h3>The <code class="literal">"name"</code> property</h3> +<pre class="programlisting"> "name" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only</pre> +<p>Name of the page.</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2" title='The "page" property'> +<a name="CajaPropertyPage--page"></a><h3>The <code class="literal">"page"</code> property</h3> +<pre class="programlisting"> "page" <a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="type">GtkWidget</span></a>* : Read / Write</pre> +<p>Widget for the property page.</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html> 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 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" ""> +<book xmlns="http://www.devhelp.net/book" title="Caja Extension Reference Manual" link="index.html" author="" name="libcaja-extension"> + <chapters> + <sub name="API Reference" link="pt01.html"> + <sub name="Extension Interfaces" link="ch01.html"> + <sub name="caja-column-provider" link="libcaja-extension-caja-column-provider.html"/> + <sub name="CajaColumn" link="libcaja-extension-caja-column.html"/> + <sub name="caja-extension-types" link="libcaja-extension-caja-extension-types.html"/> + <sub name="caja-file-info" link="libcaja-extension-caja-file-info.html"/> + <sub name="caja-info-provider" link="libcaja-extension-caja-info-provider.html"/> + <sub name="caja-location-widget-provider" link="libcaja-extension-caja-location-widget-provider.html"/> + <sub name="caja-menu-provider" link="libcaja-extension-caja-menu-provider.html"/> + <sub name="CajaMenuItem" link="libcaja-extension-caja-menu.html"/> + <sub name="caja-property-page-provider" link="libcaja-extension-caja-property-page-provider.html"/> + <sub name="CajaPropertyPage" link="libcaja-extension-caja-property-page.html"/> + </sub> + </sub> + <sub name="Index" link="ix01.html"/> + </chapters> + <functions> + <function name="CajaColumnProvider" link="libcaja-extension-caja-column-provider.html#CajaColumnProvider-struct"/> + <function name="CajaColumnProviderIface" link="libcaja-extension-caja-column-provider.html#CajaColumnProviderIface"/> + <function name="caja_column_provider_get_columns ()" link="libcaja-extension-caja-column-provider.html#caja-column-provider-get-columns"/> + <function name="CajaColumnDetails" link="libcaja-extension-caja-column.html#CajaColumnDetails"/> + <function name="CajaColumn" link="libcaja-extension-caja-column.html#CajaColumn-struct"/> + <function name="caja_column_new ()" link="libcaja-extension-caja-column.html#caja-column-new"/> + <function name="The "attribute" property" link="libcaja-extension-caja-column.html#CajaColumn--attribute"/> + <function name="The "attribute-q" property" link="libcaja-extension-caja-column.html#CajaColumn--attribute-q"/> + <function name="The "description" property" link="libcaja-extension-caja-column.html#CajaColumn--description"/> + <function name="The "label" property" link="libcaja-extension-caja-column.html#CajaColumn--label"/> + <function name="The "name" property" link="libcaja-extension-caja-column.html#CajaColumn--name"/> + <function name="The "xalign" property" link="libcaja-extension-caja-column.html#CajaColumn--xalign"/> + <function name="CAJA_TYPE_OPERATION_RESULT" link="libcaja-extension-caja-extension-types.html#CAJA-TYPE-OPERATION-RESULT:CAPS"/> + <function name="CajaOperationHandle" link="libcaja-extension-caja-extension-types.html#CajaOperationHandle"/> + <function name="enum CajaOperationResult" link="libcaja-extension-caja-extension-types.html#CajaOperationResult"/> + <function name="caja_operation_result_get_type ()" link="libcaja-extension-caja-extension-types.html#caja-operation-result-get-type"/> + <function name="caja_module_initialize ()" link="libcaja-extension-caja-extension-types.html#caja-module-initialize"/> + <function name="caja_module_shutdown ()" link="libcaja-extension-caja-extension-types.html#caja-module-shutdown"/> + <function name="caja_module_list_types ()" link="libcaja-extension-caja-extension-types.html#caja-module-list-types"/> + <function name="CAJA_FILE_DEFINED" link="libcaja-extension-caja-file-info.html#CAJA-FILE-DEFINED:CAPS"/> + <function name="CajaFile" link="libcaja-extension-caja-file-info.html#CajaFile"/> + <function name="CajaFileInfo" link="libcaja-extension-caja-file-info.html#CajaFileInfo"/> + <function name="CajaFileInfoIface" link="libcaja-extension-caja-file-info.html#CajaFileInfoIface"/> + <function name="caja_file_info_list_copy ()" link="libcaja-extension-caja-file-info.html#caja-file-info-list-copy"/> + <function name="caja_file_info_list_free ()" link="libcaja-extension-caja-file-info.html#caja-file-info-list-free"/> + <function name="caja_file_info_is_gone ()" link="libcaja-extension-caja-file-info.html#caja-file-info-is-gone"/> + <function name="caja_file_info_get_file_type ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-file-type"/> + <function name="caja_file_info_get_location ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-location"/> + <function name="caja_file_info_get_name ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-name"/> + <function name="caja_file_info_get_uri ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-uri"/> + <function name="caja_file_info_get_activation_uri ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-activation-uri"/> + <function name="caja_file_info_get_parent_location ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-parent-location"/> + <function name="caja_file_info_get_parent_uri ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-parent-uri"/> + <function name="caja_file_info_get_mount ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-mount"/> + <function name="caja_file_info_get_uri_scheme ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-uri-scheme"/> + <function name="caja_file_info_get_parent_info ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-parent-info"/> + <function name="caja_file_info_get_mime_type ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-mime-type"/> + <function name="caja_file_info_is_mime_type ()" link="libcaja-extension-caja-file-info.html#caja-file-info-is-mime-type"/> + <function name="caja_file_info_is_directory ()" link="libcaja-extension-caja-file-info.html#caja-file-info-is-directory"/> + <function name="caja_file_info_can_write ()" link="libcaja-extension-caja-file-info.html#caja-file-info-can-write"/> + <function name="caja_file_info_add_emblem ()" link="libcaja-extension-caja-file-info.html#caja-file-info-add-emblem"/> + <function name="caja_file_info_get_string_attribute ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-string-attribute"/> + <function name="caja_file_info_add_string_attribute ()" link="libcaja-extension-caja-file-info.html#caja-file-info-add-string-attribute"/> + <function name="caja_file_info_invalidate_extension_info ()" link="libcaja-extension-caja-file-info.html#caja-file-info-invalidate-extension-info"/> + <function name="CajaInfoProvider" link="libcaja-extension-caja-info-provider.html#CajaInfoProvider-struct"/> + <function name="CajaInfoProviderIface" link="libcaja-extension-caja-info-provider.html#CajaInfoProviderIface"/> + <function name="CajaInfoProviderUpdateComplete ()" link="libcaja-extension-caja-info-provider.html#CajaInfoProviderUpdateComplete"/> + <function name="caja_info_provider_update_file_info ()" link="libcaja-extension-caja-info-provider.html#caja-info-provider-update-file-info"/> + <function name="caja_info_provider_cancel_update ()" link="libcaja-extension-caja-info-provider.html#caja-info-provider-cancel-update"/> + <function name="caja_info_provider_update_complete_invoke ()" link="libcaja-extension-caja-info-provider.html#caja-info-provider-update-complete-invoke"/> + <function name="CajaLocationWidgetProvider" link="libcaja-extension-caja-location-widget-provider.html#CajaLocationWidgetProvider-struct"/> + <function name="CajaLocationWidgetProviderIface" link="libcaja-extension-caja-location-widget-provider.html#CajaLocationWidgetProviderIface"/> + <function name="caja_location_widget_provider_get_widget ()" link="libcaja-extension-caja-location-widget-provider.html#caja-location-widget-provider-get-widget"/> + <function name="CajaMenuProvider" link="libcaja-extension-caja-menu-provider.html#CajaMenuProvider-struct"/> + <function name="CajaMenuProviderIface" link="libcaja-extension-caja-menu-provider.html#CajaMenuProviderIface"/> + <function name="caja_menu_provider_get_file_items ()" link="libcaja-extension-caja-menu-provider.html#caja-menu-provider-get-file-items"/> + <function name="caja_menu_provider_get_background_items ()" link="libcaja-extension-caja-menu-provider.html#caja-menu-provider-get-background-items"/> + <function name="caja_menu_provider_get_toolbar_items ()" link="libcaja-extension-caja-menu-provider.html#caja-menu-provider-get-toolbar-items"/> + <function name="caja_menu_provider_emit_items_updated_signal ()" link="libcaja-extension-caja-menu-provider.html#caja-menu-provider-emit-items-updated-signal"/> + <function name="The "items-updated" signal" link="libcaja-extension-caja-menu-provider.html#CajaMenuProvider-items-updated"/> + <function name="CAJA_TYPE_MENU_ITEM" link="libcaja-extension-caja-menu.html#CAJA-TYPE-MENU-ITEM:CAPS"/> + <function name="CAJA_MENU_ITEM()" link="libcaja-extension-caja-menu.html#CAJA-MENU-ITEM:CAPS"/> + <function name="CAJA_MENU_ITEM_CLASS()" link="libcaja-extension-caja-menu.html#CAJA-MENU-ITEM-CLASS:CAPS"/> + <function name="CAJA_MENU_IS_ITEM()" link="libcaja-extension-caja-menu.html#CAJA-MENU-IS-ITEM:CAPS"/> + <function name="CAJA_MENU_IS_ITEM_CLASS()" link="libcaja-extension-caja-menu.html#CAJA-MENU-IS-ITEM-CLASS:CAPS"/> + <function name="CAJA_MENU_ITEM_GET_CLASS()" link="libcaja-extension-caja-menu.html#CAJA-MENU-ITEM-GET-CLASS:CAPS"/> + <function name="CajaMenuPrivate" link="libcaja-extension-caja-menu.html#CajaMenuPrivate"/> + <function name="CajaMenuItemDetails" link="libcaja-extension-caja-menu.html#CajaMenuItemDetails"/> + <function name="CajaMenu" link="libcaja-extension-caja-menu.html#CajaMenu-struct"/> + <function name="CajaMenuItem" link="libcaja-extension-caja-menu.html#CajaMenuItem-struct"/> + <function name="caja_menu_new ()" link="libcaja-extension-caja-menu.html#caja-menu-new"/> + <function name="caja_menu_append_item ()" link="libcaja-extension-caja-menu.html#caja-menu-append-item"/> + <function name="caja_menu_get_items ()" link="libcaja-extension-caja-menu.html#caja-menu-get-items"/> + <function name="caja_menu_item_list_free ()" link="libcaja-extension-caja-menu.html#caja-menu-item-list-free"/> + <function name="caja_menu_item_get_type ()" link="libcaja-extension-caja-menu.html#caja-menu-item-get-type"/> + <function name="caja_menu_item_new ()" link="libcaja-extension-caja-menu.html#caja-menu-item-new"/> + <function name="caja_menu_item_activate ()" link="libcaja-extension-caja-menu.html#caja-menu-item-activate"/> + <function name="caja_menu_item_set_submenu ()" link="libcaja-extension-caja-menu.html#caja-menu-item-set-submenu"/> + <function name="The "icon" property" link="libcaja-extension-caja-menu.html#CajaMenuItem--icon"/> + <function name="The "label" property" link="libcaja-extension-caja-menu.html#CajaMenuItem--label"/> + <function name="The "menu" property" link="libcaja-extension-caja-menu.html#CajaMenuItem--menu"/> + <function name="The "name" property" link="libcaja-extension-caja-menu.html#CajaMenuItem--name"/> + <function name="The "priority" property" link="libcaja-extension-caja-menu.html#CajaMenuItem--priority"/> + <function name="The "sensitive" property" link="libcaja-extension-caja-menu.html#CajaMenuItem--sensitive"/> + <function name="The "tip" property" link="libcaja-extension-caja-menu.html#CajaMenuItem--tip"/> + <function name="The "activate" signal" link="libcaja-extension-caja-menu.html#CajaMenuItem-activate"/> + <function name="CajaPropertyPageProvider" link="libcaja-extension-caja-property-page-provider.html#CajaPropertyPageProvider-struct"/> + <function name="CajaPropertyPageProviderIface" link="libcaja-extension-caja-property-page-provider.html#CajaPropertyPageProviderIface"/> + <function name="caja_property_page_provider_get_pages ()" link="libcaja-extension-caja-property-page-provider.html#caja-property-page-provider-get-pages"/> + <function name="CajaPropertyPageDetails" link="libcaja-extension-caja-property-page.html#CajaPropertyPageDetails"/> + <function name="CajaPropertyPage" link="libcaja-extension-caja-property-page.html#CajaPropertyPage-struct"/> + <function name="caja_property_page_new ()" link="libcaja-extension-caja-property-page.html#caja-property-page-new"/> + <function name="The "label" property" link="libcaja-extension-caja-property-page.html#CajaPropertyPage--label"/> + <function name="The "name" property" link="libcaja-extension-caja-property-page.html#CajaPropertyPage--name"/> + <function name="The "page" property" link="libcaja-extension-caja-property-page.html#CajaPropertyPage--page"/> + </functions> +</book> 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 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE book PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" ""> +<book xmlns="http://www.devhelp.net/book" title="Caja Extension Reference Manual" link="index.html" author="" name="libcaja-extension" version="2" language="c"> + <chapters> + <sub name="API Reference" link="pt01.html"> + <sub name="Extension Interfaces" link="ch01.html"> + <sub name="caja-column-provider" link="libcaja-extension-caja-column-provider.html"/> + <sub name="CajaColumn" link="libcaja-extension-caja-column.html"/> + <sub name="caja-extension-types" link="libcaja-extension-caja-extension-types.html"/> + <sub name="caja-file-info" link="libcaja-extension-caja-file-info.html"/> + <sub name="caja-info-provider" link="libcaja-extension-caja-info-provider.html"/> + <sub name="caja-location-widget-provider" link="libcaja-extension-caja-location-widget-provider.html"/> + <sub name="caja-menu-provider" link="libcaja-extension-caja-menu-provider.html"/> + <sub name="CajaMenuItem" link="libcaja-extension-caja-menu.html"/> + <sub name="caja-property-page-provider" link="libcaja-extension-caja-property-page-provider.html"/> + <sub name="CajaPropertyPage" link="libcaja-extension-caja-property-page.html"/> + </sub> + </sub> + <sub name="Index" link="ix01.html"/> + </chapters> + <functions> + <keyword type="struct" name="CajaColumnProvider" link="libcaja-extension-caja-column-provider.html#CajaColumnProvider-struct"/> + <keyword type="struct" name="CajaColumnProviderIface" link="libcaja-extension-caja-column-provider.html#CajaColumnProviderIface"/> + <keyword type="function" name="caja_column_provider_get_columns ()" link="libcaja-extension-caja-column-provider.html#caja-column-provider-get-columns"/> + <keyword type="struct" name="CajaColumnDetails" link="libcaja-extension-caja-column.html#CajaColumnDetails"/> + <keyword type="struct" name="CajaColumn" link="libcaja-extension-caja-column.html#CajaColumn-struct"/> + <keyword type="function" name="caja_column_new ()" link="libcaja-extension-caja-column.html#caja-column-new"/> + <keyword type="property" name="The "attribute" property" link="libcaja-extension-caja-column.html#CajaColumn--attribute"/> + <keyword type="property" name="The "attribute-q" property" link="libcaja-extension-caja-column.html#CajaColumn--attribute-q"/> + <keyword type="property" name="The "description" property" link="libcaja-extension-caja-column.html#CajaColumn--description"/> + <keyword type="property" name="The "label" property" link="libcaja-extension-caja-column.html#CajaColumn--label"/> + <keyword type="property" name="The "name" property" link="libcaja-extension-caja-column.html#CajaColumn--name"/> + <keyword type="property" name="The "xalign" property" link="libcaja-extension-caja-column.html#CajaColumn--xalign"/> + <keyword type="macro" name="CAJA_TYPE_OPERATION_RESULT" link="libcaja-extension-caja-extension-types.html#CAJA-TYPE-OPERATION-RESULT:CAPS"/> + <keyword type="struct" name="CajaOperationHandle" link="libcaja-extension-caja-extension-types.html#CajaOperationHandle"/> + <keyword type="enum" name="enum CajaOperationResult" link="libcaja-extension-caja-extension-types.html#CajaOperationResult"/> + <keyword type="function" name="caja_operation_result_get_type ()" link="libcaja-extension-caja-extension-types.html#caja-operation-result-get-type"/> + <keyword type="function" name="caja_module_initialize ()" link="libcaja-extension-caja-extension-types.html#caja-module-initialize"/> + <keyword type="function" name="caja_module_shutdown ()" link="libcaja-extension-caja-extension-types.html#caja-module-shutdown"/> + <keyword type="function" name="caja_module_list_types ()" link="libcaja-extension-caja-extension-types.html#caja-module-list-types"/> + <keyword type="macro" name="CAJA_FILE_DEFINED" link="libcaja-extension-caja-file-info.html#CAJA-FILE-DEFINED:CAPS"/> + <keyword type="typedef" name="CajaFile" link="libcaja-extension-caja-file-info.html#CajaFile"/> + <keyword type="typedef" name="CajaFileInfo" link="libcaja-extension-caja-file-info.html#CajaFileInfo"/> + <keyword type="struct" name="CajaFileInfoIface" link="libcaja-extension-caja-file-info.html#CajaFileInfoIface"/> + <keyword type="function" name="caja_file_info_list_copy ()" link="libcaja-extension-caja-file-info.html#caja-file-info-list-copy"/> + <keyword type="function" name="caja_file_info_list_free ()" link="libcaja-extension-caja-file-info.html#caja-file-info-list-free"/> + <keyword type="function" name="caja_file_info_is_gone ()" link="libcaja-extension-caja-file-info.html#caja-file-info-is-gone"/> + <keyword type="function" name="caja_file_info_get_file_type ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-file-type"/> + <keyword type="function" name="caja_file_info_get_location ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-location"/> + <keyword type="function" name="caja_file_info_get_name ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-name"/> + <keyword type="function" name="caja_file_info_get_uri ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-uri"/> + <keyword type="function" name="caja_file_info_get_activation_uri ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-activation-uri"/> + <keyword type="function" name="caja_file_info_get_parent_location ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-parent-location"/> + <keyword type="function" name="caja_file_info_get_parent_uri ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-parent-uri"/> + <keyword type="function" name="caja_file_info_get_mount ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-mount"/> + <keyword type="function" name="caja_file_info_get_uri_scheme ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-uri-scheme"/> + <keyword type="function" name="caja_file_info_get_parent_info ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-parent-info"/> + <keyword type="function" name="caja_file_info_get_mime_type ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-mime-type"/> + <keyword type="function" name="caja_file_info_is_mime_type ()" link="libcaja-extension-caja-file-info.html#caja-file-info-is-mime-type"/> + <keyword type="function" name="caja_file_info_is_directory ()" link="libcaja-extension-caja-file-info.html#caja-file-info-is-directory"/> + <keyword type="function" name="caja_file_info_can_write ()" link="libcaja-extension-caja-file-info.html#caja-file-info-can-write"/> + <keyword type="function" name="caja_file_info_add_emblem ()" link="libcaja-extension-caja-file-info.html#caja-file-info-add-emblem"/> + <keyword type="function" name="caja_file_info_get_string_attribute ()" link="libcaja-extension-caja-file-info.html#caja-file-info-get-string-attribute"/> + <keyword type="function" name="caja_file_info_add_string_attribute ()" link="libcaja-extension-caja-file-info.html#caja-file-info-add-string-attribute"/> + <keyword type="function" name="caja_file_info_invalidate_extension_info ()" link="libcaja-extension-caja-file-info.html#caja-file-info-invalidate-extension-info"/> + <keyword type="struct" name="CajaInfoProvider" link="libcaja-extension-caja-info-provider.html#CajaInfoProvider-struct"/> + <keyword type="struct" name="CajaInfoProviderIface" link="libcaja-extension-caja-info-provider.html#CajaInfoProviderIface"/> + <keyword type="function" name="CajaInfoProviderUpdateComplete ()" link="libcaja-extension-caja-info-provider.html#CajaInfoProviderUpdateComplete"/> + <keyword type="function" name="caja_info_provider_update_file_info ()" link="libcaja-extension-caja-info-provider.html#caja-info-provider-update-file-info"/> + <keyword type="function" name="caja_info_provider_cancel_update ()" link="libcaja-extension-caja-info-provider.html#caja-info-provider-cancel-update"/> + <keyword type="function" name="caja_info_provider_update_complete_invoke ()" link="libcaja-extension-caja-info-provider.html#caja-info-provider-update-complete-invoke"/> + <keyword type="struct" name="CajaLocationWidgetProvider" link="libcaja-extension-caja-location-widget-provider.html#CajaLocationWidgetProvider-struct"/> + <keyword type="struct" name="CajaLocationWidgetProviderIface" link="libcaja-extension-caja-location-widget-provider.html#CajaLocationWidgetProviderIface"/> + <keyword type="function" name="caja_location_widget_provider_get_widget ()" link="libcaja-extension-caja-location-widget-provider.html#caja-location-widget-provider-get-widget"/> + <keyword type="struct" name="CajaMenuProvider" link="libcaja-extension-caja-menu-provider.html#CajaMenuProvider-struct"/> + <keyword type="struct" name="CajaMenuProviderIface" link="libcaja-extension-caja-menu-provider.html#CajaMenuProviderIface"/> + <keyword type="function" name="caja_menu_provider_get_file_items ()" link="libcaja-extension-caja-menu-provider.html#caja-menu-provider-get-file-items"/> + <keyword type="function" name="caja_menu_provider_get_background_items ()" link="libcaja-extension-caja-menu-provider.html#caja-menu-provider-get-background-items"/> + <keyword type="function" name="caja_menu_provider_get_toolbar_items ()" link="libcaja-extension-caja-menu-provider.html#caja-menu-provider-get-toolbar-items"/> + <keyword type="function" name="caja_menu_provider_emit_items_updated_signal ()" link="libcaja-extension-caja-menu-provider.html#caja-menu-provider-emit-items-updated-signal"/> + <keyword type="signal" name="The "items-updated" signal" link="libcaja-extension-caja-menu-provider.html#CajaMenuProvider-items-updated"/> + <keyword type="macro" name="CAJA_TYPE_MENU_ITEM" link="libcaja-extension-caja-menu.html#CAJA-TYPE-MENU-ITEM:CAPS"/> + <keyword type="macro" name="CAJA_MENU_ITEM()" link="libcaja-extension-caja-menu.html#CAJA-MENU-ITEM:CAPS"/> + <keyword type="macro" name="CAJA_MENU_ITEM_CLASS()" link="libcaja-extension-caja-menu.html#CAJA-MENU-ITEM-CLASS:CAPS"/> + <keyword type="macro" name="CAJA_MENU_IS_ITEM()" link="libcaja-extension-caja-menu.html#CAJA-MENU-IS-ITEM:CAPS"/> + <keyword type="macro" name="CAJA_MENU_IS_ITEM_CLASS()" link="libcaja-extension-caja-menu.html#CAJA-MENU-IS-ITEM-CLASS:CAPS"/> + <keyword type="macro" name="CAJA_MENU_ITEM_GET_CLASS()" link="libcaja-extension-caja-menu.html#CAJA-MENU-ITEM-GET-CLASS:CAPS"/> + <keyword type="struct" name="CajaMenuPrivate" link="libcaja-extension-caja-menu.html#CajaMenuPrivate"/> + <keyword type="struct" name="CajaMenuItemDetails" link="libcaja-extension-caja-menu.html#CajaMenuItemDetails"/> + <keyword type="struct" name="CajaMenu" link="libcaja-extension-caja-menu.html#CajaMenu-struct"/> + <keyword type="struct" name="CajaMenuItem" link="libcaja-extension-caja-menu.html#CajaMenuItem-struct"/> + <keyword type="function" name="caja_menu_new ()" link="libcaja-extension-caja-menu.html#caja-menu-new"/> + <keyword type="function" name="caja_menu_append_item ()" link="libcaja-extension-caja-menu.html#caja-menu-append-item"/> + <keyword type="function" name="caja_menu_get_items ()" link="libcaja-extension-caja-menu.html#caja-menu-get-items"/> + <keyword type="function" name="caja_menu_item_list_free ()" link="libcaja-extension-caja-menu.html#caja-menu-item-list-free"/> + <keyword type="function" name="caja_menu_item_get_type ()" link="libcaja-extension-caja-menu.html#caja-menu-item-get-type"/> + <keyword type="function" name="caja_menu_item_new ()" link="libcaja-extension-caja-menu.html#caja-menu-item-new"/> + <keyword type="function" name="caja_menu_item_activate ()" link="libcaja-extension-caja-menu.html#caja-menu-item-activate"/> + <keyword type="function" name="caja_menu_item_set_submenu ()" link="libcaja-extension-caja-menu.html#caja-menu-item-set-submenu"/> + <keyword type="property" name="The "icon" property" link="libcaja-extension-caja-menu.html#CajaMenuItem--icon"/> + <keyword type="property" name="The "label" property" link="libcaja-extension-caja-menu.html#CajaMenuItem--label"/> + <keyword type="property" name="The "menu" property" link="libcaja-extension-caja-menu.html#CajaMenuItem--menu"/> + <keyword type="property" name="The "name" property" link="libcaja-extension-caja-menu.html#CajaMenuItem--name"/> + <keyword type="property" name="The "priority" property" link="libcaja-extension-caja-menu.html#CajaMenuItem--priority"/> + <keyword type="property" name="The "sensitive" property" link="libcaja-extension-caja-menu.html#CajaMenuItem--sensitive"/> + <keyword type="property" name="The "tip" property" link="libcaja-extension-caja-menu.html#CajaMenuItem--tip"/> + <keyword type="signal" name="The "activate" signal" link="libcaja-extension-caja-menu.html#CajaMenuItem-activate"/> + <keyword type="struct" name="CajaPropertyPageProvider" link="libcaja-extension-caja-property-page-provider.html#CajaPropertyPageProvider-struct"/> + <keyword type="struct" name="CajaPropertyPageProviderIface" link="libcaja-extension-caja-property-page-provider.html#CajaPropertyPageProviderIface"/> + <keyword type="function" name="caja_property_page_provider_get_pages ()" link="libcaja-extension-caja-property-page-provider.html#caja-property-page-provider-get-pages"/> + <keyword type="struct" name="CajaPropertyPageDetails" link="libcaja-extension-caja-property-page.html#CajaPropertyPageDetails"/> + <keyword type="struct" name="CajaPropertyPage" link="libcaja-extension-caja-property-page.html#CajaPropertyPage-struct"/> + <keyword type="function" name="caja_property_page_new ()" link="libcaja-extension-caja-property-page.html#caja-property-page-new"/> + <keyword type="property" name="The "label" property" link="libcaja-extension-caja-property-page.html#CajaPropertyPage--label"/> + <keyword type="property" name="The "name" property" link="libcaja-extension-caja-property-page.html#CajaPropertyPage--name"/> + <keyword type="property" name="The "page" property" link="libcaja-extension-caja-property-page.html#CajaPropertyPage--page"/> + </functions> +</book> 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 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Part I. API Reference</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Caja Extension Reference Manual"> +<link rel="up" href="index.html" title="Caja Extension Reference Manual"> +<link rel="prev" href="index.html" title="Caja Extension Reference Manual"> +<link rel="next" href="ch01.html" title="Extension Interfaces"> +<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> +<td><a accesskey="p" href="index.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">Caja Extension Reference Manual</th> +<td><a accesskey="n" href="ch01.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr></table> +<div class="part" title="Part I. API Reference"> +<div class="titlepage"><div><div><h1 class="title"> +<a name="id2855859"></a>Part I. API Reference</h1></div></div></div> +<div class="toc"> +<p><b>Table of Contents</b></p> +<dl> +<dt><span class="chapter"><a href="ch01.html">Extension Interfaces</a></span></dt> +<dd><dl> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-column-provider.html">caja-column-provider</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-column.html">CajaColumn</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-extension-types.html">caja-extension-types</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-file-info.html">caja-file-info</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-info-provider.html">caja-info-provider</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-location-widget-provider.html">caja-location-widget-provider</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-menu-provider.html">caja-menu-provider</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-menu.html">CajaMenuItem</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-property-page-provider.html">caja-property-page-provider</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="libcaja-extension-caja-property-page.html">CajaPropertyPage</a></span><span class="refpurpose"></span> +</dt> +</dl></dd> +</dl> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.15</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/libcaja-extension/html/right.png b/docs/reference/libcaja-extension/html/right.png Binary files differnew file mode 100644 index 00000000..92832e3a --- /dev/null +++ b/docs/reference/libcaja-extension/html/right.png 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 Binary files differnew file mode 100644 index 00000000..85b3e2a2 --- /dev/null +++ b/docs/reference/libcaja-extension/html/up.png 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 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ +<!ENTITY version SYSTEM "version.xml"> +]> + +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> + <bookinfo> + <title>Caja Extension Reference Manual</title> + <releaseinfo>For Caja-Extension &version;</releaseinfo> + + </bookinfo> + + <part> + <title>API Reference</title> + + <chapter> + <title>Extension Interfaces</title> + <xi:include href="xml/caja-column-provider.xml" /> + <xi:include href="xml/caja-column.xml" /> + <xi:include href="xml/caja-extension-i18n.xml" /> + <xi:include href="xml/caja-extension-types.xml" /> + <xi:include href="xml/caja-file-info.xml" /> + <xi:include href="xml/caja-info-provider.xml" /> + <xi:include href="xml/caja-location-widget-provider.xml" /> + <xi:include href="xml/caja-menu-provider.xml" /> + <xi:include href="xml/caja-menu.xml" /> + <xi:include href="xml/caja-property-page-provider.xml" /> + <xi:include href="xml/caja-property-page.xml" /> + </chapter> + + </part> + <index> + <title id="index-all">Index</title> + </index> +</book> 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 --- /dev/null +++ b/docs/reference/libcaja-extension/libcaja-extension-overrides.txt 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 @@ +<SECTION> +<FILE>caja-location-widget-provider</FILE> +CajaLocationWidgetProvider +CajaLocationWidgetProviderIface +caja_location_widget_provider_get_widget +<SUBSECTION Standard> +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 +</SECTION> + +<SECTION> +<FILE>caja-menu-provider</FILE> +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 +<SUBSECTION Standard> +CAJA_MENU_PROVIDER +CAJA_IS_MENU_PROVIDER +CAJA_TYPE_MENU_PROVIDER +caja_menu_provider_get_type +CAJA_MENU_PROVIDER_GET_IFACE +</SECTION> + +<SECTION> +<FILE>caja-menu</FILE> +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 +<TITLE>CajaMenu</TITLE> +CajaMenu +<TITLE>CajaMenuItem</TITLE> +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 +<SUBSECTION Standard> +CAJA_MENU +CAJA_IS_MENU +CAJA_TYPE_MENU +caja_menu_get_type +CAJA_MENU_CLASS +CAJA_IS_MENU_CLASS +CAJA_MENU_GET_CLASS +</SECTION> + +<SECTION> +<FILE>caja-column-provider</FILE> +CajaColumnProvider +CajaColumnProviderIface +caja_column_provider_get_columns +<SUBSECTION Standard> +CAJA_COLUMN_PROVIDER +CAJA_IS_COLUMN_PROVIDER +CAJA_TYPE_COLUMN_PROVIDER +caja_column_provider_get_type +CAJA_COLUMN_PROVIDER_GET_IFACE +</SECTION> + +<SECTION> +<FILE>caja-property-page-provider</FILE> +CajaPropertyPageProvider +CajaPropertyPageProviderIface +caja_property_page_provider_get_pages +<SUBSECTION Standard> +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 +</SECTION> + +<SECTION> +<FILE>caja-file-info</FILE> +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 +<SUBSECTION Standard> +CAJA_FILE_INFO +CAJA_IS_FILE_INFO +CAJA_TYPE_FILE_INFO +caja_file_info_get_type +CAJA_FILE_INFO_GET_IFACE +</SECTION> + +<SECTION> +<FILE>caja-column</FILE> +CajaColumnDetails +<TITLE>CajaColumn</TITLE> +CajaColumn +caja_column_new +<SUBSECTION Standard> +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 +</SECTION> + +<SECTION> +<FILE>caja-info-provider</FILE> +CajaInfoProvider +CajaInfoProviderIface +CajaInfoProviderUpdateComplete +caja_info_provider_update_file_info +caja_info_provider_cancel_update +caja_info_provider_update_complete_invoke +<SUBSECTION Standard> +CAJA_INFO_PROVIDER +CAJA_IS_INFO_PROVIDER +CAJA_TYPE_INFO_PROVIDER +caja_info_provider_get_type +CAJA_INFO_PROVIDER_GET_IFACE +</SECTION> + +<SECTION> +<FILE>caja-property-page</FILE> +CajaPropertyPageDetails +<TITLE>CajaPropertyPage</TITLE> +CajaPropertyPage +caja_property_page_new +<SUBSECTION Standard> +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 +</SECTION> + +<SECTION> +<FILE>caja-extension-types</FILE> +CAJA_TYPE_OPERATION_RESULT +CajaOperationHandle +CajaOperationResult +caja_operation_result_get_type +caja_module_initialize +caja_module_shutdown +caja_module_list_types +</SECTION> + +<SECTION> +<FILE>caja-menu-item</FILE> +</SECTION> + 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 @@ +<!-- ##### SECTION Title ##### --> +caja-column-provider + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT CajaColumnProvider ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaColumnProviderIface ##### --> +<para> + +</para> + +@g_iface: +@get_columns: + +<!-- ##### FUNCTION caja_column_provider_get_columns ##### --> +<para> + +</para> + +@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 @@ +<!-- ##### SECTION Title ##### --> +CajaColumn + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT CajaColumnDetails ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaColumn ##### --> +<para> + +</para> + + +<!-- ##### ARG CajaColumn:attribute ##### --> +<para> + +</para> + +<!-- ##### ARG CajaColumn:attribute-q ##### --> +<para> + +</para> + +<!-- ##### ARG CajaColumn:description ##### --> +<para> + +</para> + +<!-- ##### ARG CajaColumn:label ##### --> +<para> + +</para> + +<!-- ##### ARG CajaColumn:name ##### --> +<para> + +</para> + +<!-- ##### ARG CajaColumn:xalign ##### --> +<para> + +</para> + +<!-- ##### FUNCTION caja_column_new ##### --> +<para> + +</para> + +@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 @@ +<!-- ##### SECTION Title ##### --> +caja-extension-types + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO CAJA_TYPE_OPERATION_RESULT ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT CajaOperationHandle ##### --> +<para> + +</para> + + +<!-- ##### ENUM CajaOperationResult ##### --> +<para> + +</para> + +@CAJA_OPERATION_COMPLETE: +@CAJA_OPERATION_FAILED: +@CAJA_OPERATION_IN_PROGRESS: + +<!-- ##### FUNCTION caja_operation_result_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION caja_module_initialize ##### --> +<para> + +</para> + +@module: + + +<!-- ##### FUNCTION caja_module_shutdown ##### --> +<para> + +</para> + +@void: + + +<!-- ##### FUNCTION caja_module_list_types ##### --> +<para> + +</para> + +@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 @@ +<!-- ##### SECTION Title ##### --> +caja-file-info + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO CAJA_FILE_DEFINED ##### --> +<para> + +</para> + + + +<!-- ##### TYPEDEF CajaFile ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF CajaFileInfo ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaFileInfoIface ##### --> +<para> + +</para> + +@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: + +<!-- ##### FUNCTION caja_file_info_list_copy ##### --> +<para> + +</para> + +@files: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_list_free ##### --> +<para> + +</para> + +@files: + + +<!-- ##### FUNCTION caja_file_info_is_gone ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_file_type ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_location ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_name ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_uri ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_activation_uri ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_parent_location ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_parent_uri ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_mount ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_uri_scheme ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_parent_info ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_get_mime_type ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_is_mime_type ##### --> +<para> + +</para> + +@file: +@mime_type: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_is_directory ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_can_write ##### --> +<para> + +</para> + +@file: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_add_emblem ##### --> +<para> + +</para> + +@file: +@emblem_name: + + +<!-- ##### FUNCTION caja_file_info_get_string_attribute ##### --> +<para> + +</para> + +@file: +@attribute_name: +@Returns: + + +<!-- ##### FUNCTION caja_file_info_add_string_attribute ##### --> +<para> + +</para> + +@file: +@attribute_name: +@value: + + +<!-- ##### FUNCTION caja_file_info_invalidate_extension_info ##### --> +<para> + +</para> + +@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 @@ +<!-- ##### SECTION Title ##### --> +caja-info-provider + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT CajaInfoProvider ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaInfoProviderIface ##### --> +<para> + +</para> + +@g_iface: +@update_file_info: +@cancel_update: + +<!-- ##### USER_FUNCTION CajaInfoProviderUpdateComplete ##### --> +<para> + +</para> + +@provider: +@handle: +@result: +@user_data: + + +<!-- ##### FUNCTION caja_info_provider_update_file_info ##### --> +<para> + +</para> + +@provider: +@file: +@update_complete: +@handle: +@Returns: + + +<!-- ##### FUNCTION caja_info_provider_cancel_update ##### --> +<para> + +</para> + +@provider: +@handle: + + +<!-- ##### FUNCTION caja_info_provider_update_complete_invoke ##### --> +<para> + +</para> + +@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 @@ +<!-- ##### SECTION Title ##### --> +caja-location-widget-provider + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT CajaLocationWidgetProvider ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaLocationWidgetProviderIface ##### --> +<para> + +</para> + +@g_iface: +@get_widget: + +<!-- ##### FUNCTION caja_location_widget_provider_get_widget ##### --> +<para> + +</para> + +@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 @@ +<!-- ##### SECTION Title ##### --> +caja-menu-item + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + 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 @@ +<!-- ##### SECTION Title ##### --> +caja-menu-provider + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT CajaMenuProvider ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL CajaMenuProvider::items-updated ##### --> +<para> + +</para> + +@cajamenuprovider: the object which received the signal. + +<!-- ##### STRUCT CajaMenuProviderIface ##### --> +<para> + +</para> + +@g_iface: +@get_file_items: +@get_background_items: +@get_toolbar_items: + +<!-- ##### FUNCTION caja_menu_provider_get_file_items ##### --> +<para> + +</para> + +@provider: +@window: +@files: +@Returns: + + +<!-- ##### FUNCTION caja_menu_provider_get_background_items ##### --> +<para> + +</para> + +@provider: +@window: +@current_folder: +@Returns: + + +<!-- ##### FUNCTION caja_menu_provider_get_toolbar_items ##### --> +<para> + +</para> + +@provider: +@window: +@current_folder: +@Returns: + + +<!-- ##### FUNCTION caja_menu_provider_emit_items_updated_signal ##### --> +<para> + +</para> + +@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 @@ +<!-- ##### SECTION Title ##### --> +CajaMenuItem + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO CAJA_TYPE_MENU_ITEM ##### --> +<para> + +</para> + + + +<!-- ##### MACRO CAJA_MENU_ITEM ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO CAJA_MENU_ITEM_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO CAJA_MENU_IS_ITEM ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO CAJA_MENU_IS_ITEM_CLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO CAJA_MENU_ITEM_GET_CLASS ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### STRUCT CajaMenuPrivate ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaMenuItemDetails ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaMenu ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaMenuItem ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL CajaMenuItem::activate ##### --> +<para> + +</para> + +@cajamenuitem: the object which received the signal. + +<!-- ##### ARG CajaMenuItem:icon ##### --> +<para> + +</para> + +<!-- ##### ARG CajaMenuItem:label ##### --> +<para> + +</para> + +<!-- ##### ARG CajaMenuItem:menu ##### --> +<para> + +</para> + +<!-- ##### ARG CajaMenuItem:name ##### --> +<para> + +</para> + +<!-- ##### ARG CajaMenuItem:priority ##### --> +<para> + +</para> + +<!-- ##### ARG CajaMenuItem:sensitive ##### --> +<para> + +</para> + +<!-- ##### ARG CajaMenuItem:tip ##### --> +<para> + +</para> + +<!-- ##### FUNCTION caja_menu_new ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION caja_menu_append_item ##### --> +<para> + +</para> + +@menu: +@item: + + +<!-- ##### FUNCTION caja_menu_get_items ##### --> +<para> + +</para> + +@menu: +@Returns: + + +<!-- ##### FUNCTION caja_menu_item_list_free ##### --> +<para> + +</para> + +@item_list: + + +<!-- ##### FUNCTION caja_menu_item_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### FUNCTION caja_menu_item_new ##### --> +<para> + +</para> + +@name: +@label: +@tip: +@icon: +@Returns: + + +<!-- ##### FUNCTION caja_menu_item_activate ##### --> +<para> + +</para> + +@item: + + +<!-- ##### FUNCTION caja_menu_item_set_submenu ##### --> +<para> + +</para> + +@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 @@ +<!-- ##### SECTION Title ##### --> +caja-property-page-provider + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT CajaPropertyPageProvider ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaPropertyPageProviderIface ##### --> +<para> + +</para> + +@g_iface: +@get_pages: + +<!-- ##### FUNCTION caja_property_page_provider_get_pages ##### --> +<para> + +</para> + +@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 @@ +<!-- ##### SECTION Title ##### --> +CajaPropertyPage + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### STRUCT CajaPropertyPageDetails ##### --> +<para> + +</para> + + +<!-- ##### STRUCT CajaPropertyPage ##### --> +<para> + +</para> + + +<!-- ##### ARG CajaPropertyPage:label ##### --> +<para> + +</para> + +<!-- ##### ARG CajaPropertyPage:name ##### --> +<para> + +</para> + +<!-- ##### ARG CajaPropertyPage:page ##### --> +<para> + +</para> + +<!-- ##### FUNCTION caja_property_page_new ##### --> +<para> + +</para> + +@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 --- /dev/null +++ b/docs/reference/libcaja-extension/tmpl/libcaja-extension-unused.sgml 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 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN"> +<HTML> +<HEAD> + <TITLE></TITLE> + <META NAME="GENERATOR" CONTENT="StarOffice/5.1 (Linux)"> + <META NAME="AUTHOR" CONTENT=" "> + <META NAME="CREATED" CONTENT="20000901;18303000"> + <META NAME="CHANGEDBY" CONTENT="Josh Barrow"> + <META NAME="CHANGED" CONTENT="20010216;14060700"> + <META HTTP-EQUIV="content-type" CONTENT="text/html;charset=iso-8859-1"> + <STYLE> + <!-- + A:link { color: #009999 } + --> + </STYLE> +</HEAD> +<BODY LINK="#009999" BGCOLOR="#ffffff"> +<P ALIGN=LEFT><FONT COLOR="#004252"><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><FONT SIZE=6><B>Caja +Smoke Tests</B></FONT></FONT></FONT></P> +<P ALIGN=LEFT STYLE="font-weight: medium"><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><FONT SIZE=4>The +Caja Smoke Tests are a minimal set of tests, to determine whether +a build is usable for testing, and to catch obvious regressions.</FONT></FONT></P> +<P ALIGN=LEFT><BR><BR> +</P> +<P ALIGN=LEFT><FONT COLOR="#004252"><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><FONT SIZE=3><B>Views</B></FONT></FONT></FONT></P> +<P ALIGN=LEFT><FONT SIZE=3><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">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.<B> +(For those inside the Eazel firewall, these are in +/h/public/QE/smoketests.)</B><BR><BR>Also be sure to be in +single-click mode. (Preferences | Click Behavior | 'Active items with +single click')<BR></FONT></FONT><BR><BR> +</P> +<TABLE WIDTH=100% BORDER=1 CELLPADDING=4 CELLSPACING=3> + <COL WIDTH=25*> + <COL WIDTH=60*> + <COL WIDTH=83*> + <COL WIDTH=87*> + <THEAD> + <TR VALIGN=TOP> + <TH WIDTH=10% BGCOLOR="#ffce39"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><SPAN STYLE="background: transparent">Test + #</SPAN></FONT></P> + </TH> + <TH WIDTH=24% BGCOLOR="#ffce39"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><SPAN STYLE="background: transparent">Test</SPAN></FONT></P> + </TH> + <TH WIDTH=33% BGCOLOR="#ffce39"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><SPAN STYLE="background: transparent">Test + Steps</SPAN></FONT></P> + </TH> + <TH WIDTH=34% BGCOLOR="#ffce39"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><SPAN STYLE="background: transparent">Expected + Results</SPAN></FONT></P> + </TH> + </TR> + </THEAD> + <TBODY> + <TR VALIGN=TOP> + <TD WIDTH=10%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">V-1</FONT></P> + </TD> + <TD WIDTH=24%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">View + as Icon</FONT></P> + </TD> + <TD WIDTH=33%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + Select "View as Icons" from pop-up menu.</FONT> + </P> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">2. + Zoom in to 400% and out to 25%, both via the pop-up menu, and via + +/- icons.</FONT></P> + <P><BR> + </P> + </TD> + <TD WIDTH=34%> + <P><BR> + </P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=10% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">V-2</FONT></P> + </TD> + <TD WIDTH=24% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">View + as List</FONT></P> + </TD> + <TD WIDTH=33% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + Select "View as List" from pop-up menu</FONT> + </P> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">2. + Zoom in to 400% and out to 25%, and via +/- icons.</FONT></P> + </TD> + <TD WIDTH=34% BGCOLOR="#ffffcc"> + <P><BR> + </P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=10%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">V-3</FONT></P> + </TD> + <TD WIDTH=24%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">View + as Music</FONT></P> + </TD> + <TD WIDTH=33%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + Select "View as Music" from pop-up menu.</FONT> + </P> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">2. + Play an MP3.</FONT></P> + </TD> + <TD WIDTH=34%> + <P><BR> + </P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=10% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">V-4</FONT></P> + </TD> + <TD WIDTH=24% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">View + as Web Page</FONT></P> + </TD> + <TD WIDTH=33% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + Click on a file of type "HTML Document".</FONT></P> + </TD> + <TD WIDTH=34% BGCOLOR="#ffffcc"> + <P><BR> + </P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=10%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">V-5</FONT></P> + </TD> + <TD WIDTH=24%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">View + as Text</FONT></P> + </TD> + <TD WIDTH=33%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + Click on a file of type "plain text".</FONT></P> + </TD> + <TD WIDTH=34%> + <P><BR> + </P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=10% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">V-6</FONT></P> + </TD> + <TD WIDTH=24% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">View + as Image</FONT></P> + </TD> + <TD WIDTH=33% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + Click on an image of type "JPEG image", "GIF + image", or "PNG image". (confirm)</FONT></P> + </TD> + <TD WIDTH=34% BGCOLOR="#ffffcc"> + <P><BR> + </P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=10%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">V-7</FONT></P> + </TD> + <TD WIDTH=24%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">View + as Hardware</FONT></P> + </TD> + <TD WIDTH=33%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + Type "hardware:" or "hardware:overview" into + the Location bar.</FONT></P> + </TD> + <TD WIDTH=34%> + <P><BR> + </P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=10% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">V-8</FONT></P> + </TD> + <TD WIDTH=24% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">View + as PDF Document</FONT></P> + </TD> + <TD WIDTH=33% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + Click on a PDF file.</FONT></P> + </TD> + <TD WIDTH=34% BGCOLOR="#ffffcc"> + <P><BR> + </P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=10%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">V-9</FONT></P> + </TD> + <TD WIDTH=24%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">View + as Package</FONT></P> + </TD> + <TD WIDTH=33%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + Click on any Red Hat Package Manager file.</FONT></P> + </TD> + <TD WIDTH=34%> + <P><BR> + </P> + </TD> + </TR> + </TBODY> +</TABLE> +<P ALIGN=LEFT><BR><BR> +</P> +<P ALIGN=LEFT><FONT COLOR="#004252"><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><FONT SIZE=3><B>File +Operations</B></FONT></FONT></FONT></P> +<P ALIGN=LEFT STYLE="font-weight: medium"><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><FONT SIZE=3>Before +beginning this section, change your Click Behavior (in Preferences) +to 'Active items with a double click'.</FONT></FONT></P> +<TABLE WIDTH=100% BORDER=1 CELLPADDING=4 CELLSPACING=3> + <COL WIDTH=25*> + <COL WIDTH=60*> + <COL WIDTH=106*> + <COL WIDTH=64*> + <THEAD> + <TR VALIGN=TOP> + <TH WIDTH=10% BGCOLOR="#ffce39"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><SPAN STYLE="background: transparent">Test + Number</SPAN></FONT></P> + </TH> + <TH WIDTH=24% BGCOLOR="#ffce39"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><SPAN STYLE="background: transparent">Test</SPAN></FONT></P> + </TH> + <TH WIDTH=42% BGCOLOR="#ffce39"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><SPAN STYLE="background: transparent">Test + Steps</SPAN></FONT></P> + </TH> + <TH WIDTH=25% BGCOLOR="#ffce39"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><SPAN STYLE="background: transparent">Expected + Results</SPAN></FONT></P> + </TH> + </TR> + </THEAD> + <TBODY> + <TR VALIGN=TOP> + <TD WIDTH=10%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">F-1</FONT></P> + </TD> + <TD WIDTH=24%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">Rename + a file or folder</FONT></P> + </TD> + <TD WIDTH=42%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + Click on a file, and choose "Rename" from the File or + context menu.</FONT> + </P> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">2. + Type in a new name</FONT></P> + </TD> + <TD WIDTH=25%> + <P><BR> + </P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=10% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">F-2</FONT></P> + </TD> + <TD WIDTH=24% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">Duplicate + a file or folder</FONT></P> + </TD> + <TD WIDTH=42% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + Click on a file, and choose "Duplicate" from the File + or context menu.</FONT></P> + </TD> + <TD WIDTH=25% BGCOLOR="#ffffcc"> + <P><BR> + </P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=10%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">F-3</FONT></P> + </TD> + <TD WIDTH=24%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">Create + a link to a file or folder</FONT></P> + </TD> + <TD WIDTH=42%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + Click on a file, and choose "Create Link" from the File + or context menu.</FONT></P> + </TD> + <TD WIDTH=25%> + <P><BR> + </P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=10% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">F-4</FONT></P> + </TD> + <TD WIDTH=24% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">Stretch + an icon</FONT></P> + </TD> + <TD WIDTH=42% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + Click on a file, and choose "Stretch Icon" from the + File or context menu.</FONT> + </P> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">2. + Drag the icon by a corner, and enlarge or shrink it.</FONT></P> + </TD> + <TD WIDTH=25% BGCOLOR="#ffffcc"> + <P><BR> + </P> + </TD> + </TR> + </TBODY> +</TABLE> +<P ALIGN=LEFT><BR><BR> +</P> +<P ALIGN=LEFT><B><FONT SIZE=3><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><FONT COLOR="#004252">Desktop +Operations</FONT></FONT></FONT></B></P> +<TABLE WIDTH=100% BORDER=1 CELLPADDING=4 CELLSPACING=3> + <COL WIDTH=26*> + <COL WIDTH=61*> + <COL WIDTH=106*> + <COL WIDTH=64*> + <THEAD> + <TR VALIGN=TOP> + <TH WIDTH=10% BGCOLOR="#ffce39"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><SPAN STYLE="background: transparent">Test + Number</SPAN></FONT></P> + </TH> + <TH WIDTH=24% BGCOLOR="#ffce39"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><SPAN STYLE="background: transparent">Test</SPAN></FONT></P> + </TH> + <TH WIDTH=41% BGCOLOR="#ffce39"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><SPAN STYLE="background: transparent">Test + Steps</SPAN></FONT></P> + </TH> + <TH WIDTH=25% BGCOLOR="#ffce39"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><SPAN STYLE="background: transparent">Expected + Results</SPAN></FONT></P> + </TH> + </TR> + </THEAD> + <TBODY> + <TR VALIGN=TOP> + <TD WIDTH=10%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">D-1</FONT></P> + </TD> + <TD WIDTH=24%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">Empty + Trash</FONT></P> + </TD> + <TD WIDTH=41%> + <P STYLE="font-style: normal"><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + Drag files or folders onto the Trash icon.</FONT></P> + <P STYLE="font-style: normal"><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">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.)</FONT></P> + <P STYLE="font-style: normal"><BR> + </P> + </TD> + <TD WIDTH=25%> + <P><BR> + </P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=10% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">D-2</FONT></P> + </TD> + <TD WIDTH=24% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">Drag + file to Desktop</FONT></P> + </TD> + <TD WIDTH=41% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + Drag a file from a Caja view window to the Desktop</FONT></P> + </TD> + <TD WIDTH=25% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">File + should be moved to desktop.</FONT></P> + </TD> + </TR> + </TBODY> +</TABLE> +<P ALIGN=LEFT STYLE="font-weight: medium"><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><BR><BR><B><FONT SIZE=3><FONT COLOR="#004252">Preferences/Customization</FONT></FONT></B></FONT></P> +<TABLE WIDTH=100% BORDER=1 CELLPADDING=4 CELLSPACING=3> + <COL WIDTH=26*> + <COL WIDTH=61*> + <COL WIDTH=57*> + <COL WIDTH=112*> + <THEAD> + <TR VALIGN=TOP> + <TH WIDTH=10% BGCOLOR="#ffce39"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><SPAN STYLE="background: transparent">Test + Number</SPAN></FONT></P> + </TH> + <TH WIDTH=24% BGCOLOR="#ffce39"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><SPAN STYLE="background: transparent">Test</SPAN></FONT></P> + </TH> + <TH WIDTH=22% BGCOLOR="#ffce39"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><SPAN STYLE="background: transparent">Test + Steps</SPAN></FONT></P> + </TH> + <TH WIDTH=44% BGCOLOR="#ffce39"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular"><SPAN STYLE="background: transparent">Expected + Results</SPAN></FONT></P> + </TH> + </TR> + </THEAD> + <TBODY> + <TR VALIGN=TOP> + <TD WIDTH=10%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">P-1</FONT></P> + </TD> + <TD WIDTH=24%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">Switch + Themes</FONT></P> + </TD> + <TD WIDTH=22%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + From a Caja window, choose "Caja Themes" from + the Edit menu.</FONT> + </P> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">2. + Try each of the themes.</FONT></P> + </TD> + <TD WIDTH=44%> + <P><BR> + </P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=10% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">P-2</FONT></P> + </TD> + <TD WIDTH=24% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">Switch + User Mode</FONT></P> + </TD> + <TD WIDTH=22% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + From a Caja window, try each of the three user modes.</FONT></P> + </TD> + <TD WIDTH=44% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">In + Beginner mode:</FONT> + </P> + <OL> + <LI><P STYLE="margin-bottom: 0in"><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">The + user mode menu's "Edit Beginner User Level" should + lead to a dialog with very minimal settings.</FONT></P> + <LI><P STYLE="margin-bottom: 0in"><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">Dot + files (e.g. .bashrc) should not be displayed.</FONT> + </P> + <LI><P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">The + "Special Flags" portion of the Show Properties + dialog's "Permissions" pane should be omitted.</FONT> + </P> + </OL> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">In + Intermediate mode:</FONT></P> + <OL> + <LI><P STYLE="margin-bottom: 0in"><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">Dot + files (e.g. .bashrc) should not be displayed.</FONT> + </P> + <LI><P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">The + "Special Flags" portion of the Show Properties + dialog's "Permissions" pane should be omitted.</FONT> + </P> + </OL> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">In + Expert mode, none of the above user experience simplification + should occur.</FONT></P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=10%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">P-3</FONT></P> + </TD> + <TD WIDTH=24%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">Switch + Anti-aliasing mode</FONT></P> + </TD> + <TD WIDTH=22%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + While in Intermediate or Expert mode, choose "Preferences..." + From the user mode menu.</FONT> + </P> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">2. + In the "Appearance" category, deselect the "Use + smoother (but slower) graphics" checkbox.</FONT></P> + </TD> + <TD WIDTH=44%> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">Text + and icons should no longer be anti-aliased.</FONT></P> + </TD> + </TR> + <TR VALIGN=TOP> + <TD WIDTH=10% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">P-4</FONT></P> + </TD> + <TD WIDTH=24% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">Change + Background</FONT></P> + </TD> + <TD WIDTH=22% BGCOLOR="#ffffcc"> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">1. + Choose "Backgrounds and Emblems" from the Edit menu.</FONT> + </P> + <P><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">2. + Drag a few colors and backgrounds to the sidebar & main + window pane.</FONT></P> + </TD> + <TD WIDTH=44% BGCOLOR="#ffffcc"> + <P><BR> + </P> + </TD> + </TR> + </TBODY> +</TABLE> +<P ALIGN=LEFT><BR><BR> +</P> +<P ALIGN=RIGHT STYLE="margin-bottom: 0in"><FONT SIZE=2 STYLE="font-size: 9pt"><FONT FACE="Arial, Helvetica, Geneva, Swiss, SunSans-Regular">Maintained +by <A HREF="mailto:[email protected]">Josh Barrow</A> for Caja +Quality Engineering, originally written by <A HREF="mailto:[email protected]">Eli +Goldberg</A>; feedback welcome.<BR>Adaptation and reuse for other +open source projects is freely permitted.<BR>Last Updated: 9/28/2000</FONT></FONT></P> +</BODY> +</HTML>
\ 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 @@ +<html> + +<head> +<title>Caja Coding Style Guide</title> +</head> + +<body> + +<p>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 +<a href="http://developer.gnome.org/doc/guides/programming-guidelines/">MATE Programming Guidelines</a>.</p> + +<p>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.</p> + +<p>I'm just getting started on this document. Feedback is welcome. +Eventually I'd like better organization and tons of examples.</p> + +<blockquote> +<p>- <a href="mailto:[email protected]">Darin</a></p> +</blockquote> + +<hr> + +<p><b>We use the most-recommended coding style from the MATE Programming +Guidelines.</b> 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).</p> + +<p><b>We prefer to use words rather than acronyms or abbreviations.</b> 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.</p> + +<p><b>We strive to have a minimum number of local variables.</b> This makes it +easier to move pieces of code around. For more on this, read +<a href="recommended-books.html#Refactoring"><i>Refactoring</i></a>.</p> + +<p><b>We use type casts as little as possible.</b> 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.</p> + +<p><b>We use typedefs from <glib.h> for things like guint, guchar and gpointer, +but not gint, gchar, or gdouble.</b> 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.</p> + +<p><b>We avoid in-band signaling.</b> 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.</p> + +<p><b>We code for clarity first.</b> Other concerns like efficiency are secondary. +Sometimes they become more important than clarity, but only once they are proven +to be a problem.</p> + +<p><b>We use for loops when they make the code easier to read.</b> The alternative +is usually to use a while loop. It's true that +"easy to read" is a subjective thing.</p> + +<p><b>We declare local variables at the beginning of a block.</b> C99 allows you +to declare variables anywhere in a function, but a lot of compilers still do not +support C99.</p> + +<p><b>We do not initialize local variables in their declarations.</b> 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.</p> + +<p><b>We always use braces, even for one-statement "blocks".</b> Our consensus is +to do things like this:</p> + +<blockquote> +<pre> +if (list != NULL) { + g_warning ("the list isn't empty"); +} +</pre> +</blockquote> + +<p>Instead of this:</p> + +<blockquote> +<pre> +if (list != NULL) + g_warning ("the list isn't empty"); +</pre> +</blockquote> + +<p>This applies to all control structures: if, while, for, do.</p> + +<p><b>We make each header "stand alone".</b> 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:</p> + +<blockquote> +<pre> +/* -*- 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. + * + * <i>License agreement goes here.</i> + * + * Author: John Sullivan <[email protected]> + */ + +#include <config.h> +#include "caja-icon-factory.h" + +#include <string.h> +#include <stdio.h> +<i>Include statements for other header files go here.</i> + +<i>Other declarations and code go here.</i> +</pre> +</blockquote> + +<hr> + +</body> + +</html> |