diff --git a/doc/ChangeLog b/doc/ChangeLog index 22c4221e4..6164141cd 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,15 @@ +2004-12-14 Shane Landrum + + * en/Gtk/FileChooser.xml: Added full docs. + * en/Gtk/FileChooserDialog.xml + * en/Gtk/FileChooserEmbed.xml + * en/Gtk/FileChooserAction.xml + * en/Gtk/FileChooserWidget.xml + * en/Gtk/FileChooserEntry.xml + * en/Gtk/FileChooserDefault.xml + * en/Gtk/FileChooserError.xml + * en/Gtk/FileChooserProp.xml: Began working on docs. + 2004-12-14 Shane Landrum * en/Gtk/TextTagInfo.xml diff --git a/doc/en/Gtk/FileChooser.xml b/doc/en/Gtk/FileChooser.xml index d6218df39..5a9a57d2a 100644 --- a/doc/en/Gtk/FileChooser.xml +++ b/doc/en/Gtk/FileChooser.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Class for a file-chooser dialog. + @@ -30,10 +30,15 @@ - To be added - a - a - To be added + + Sets the current folder for the chooser from an URI. + + a , the URI to use + a , true if the folder could be changed successfully, false otherwise + + The user will be shown the full contents of the current folder, + plus user interface elements for navigating to other folders. + @@ -44,8 +49,8 @@ - To be added - To be added + Unselects all the files in the current folder of a file chooser. + @@ -58,10 +63,26 @@ - To be added + + Sets as the current filename for + the file chooser; + If the file name isn't in the current folder of the file chooser, then the + current folder of the file chooser will be changed to the folder containing + . + a - a - To be added + a , true if both the + folder could be changed and the file was + selected successfully, false otherwise. + + This is equivalent to a sequence of + + followed by . + + Note that the file must exist, or nothing will be done except + for the directory change. To pre-enter a filename for the user, as in + a save-as dialog, use . + @@ -74,10 +95,14 @@ - To be added + + Removes a folder URI from a file chooser's list of shortcut folders. + a a - To be added + + See also . + @@ -90,10 +115,18 @@ - To be added + + Adds a folder URI to be displayed with the shortcut folders in a file + chooser. + a - a - To be added + a , true if the folder + could be added successfully, false otherwise. + + Note that shortcut folders do not get saved, as they are provided + by the application. For example, you can use this to add a + "file:///usr/share/mydrawprogram/Clipart" folder to the volume list. + @@ -104,8 +137,8 @@ - To be added - To be added + Selects all the files in the current folder of a file chooser. + @@ -118,10 +151,16 @@ - To be added + + Selects the file at . If the URI doesn't refer to a + file in the current folder of the file chooser, then the current folder of + the file chooser will be changed to the folder that's part of . + a - a - To be added + a , true if both the + folder could be changed and the URI was + selected successfully, false otherwise. + @@ -134,9 +173,10 @@ - To be added + Removes from the list of filters that the user can select between. a - To be added + + @@ -149,10 +189,14 @@ - To be added + Adds a folder to be displayed with the shortcut folders in a file chooser. a a - To be added + + Note that shortcut folders do not get saved, as they are provided by the + application. For example, you can use this to add a + "/usr/share/mydrawprogram/Clipart" folder to the volume list. + @@ -165,10 +209,14 @@ - To be added + Selects a filename. a a - To be added + + If the file name isn't in the current + folder of the file chooser, then the current folder of the file chooser will + be changed to the folder containing . + @@ -181,9 +229,14 @@ - To be added + + Unselects a currently selected filename. + a - To be added + + If the filename is not in the current directory, does not exist, or + is otherwise not currently selected, does nothing. + @@ -196,9 +249,15 @@ - To be added + + Adds to the list of filters that the + user can select between. + a - To be added + + When a filter is selected, only files that are passed by that + filter are displayed. + @@ -211,10 +270,10 @@ - To be added + Removes a folder from a file chooser's list of shortcut folders. a a - To be added + See also . @@ -227,9 +286,14 @@ - To be added + + Unselects the file referred to by . + a - To be added + + If the file is not in the current directory, does not exist, or + is otherwise not currently selected, does nothing. + @@ -242,10 +306,15 @@ - To be added + + Sets the current folder for the file chooser from a local filename. + a a - To be added + + The user will be shown the full contents of the current folder, + plus user interface elements for navigating to other folders. + @@ -258,10 +327,25 @@ - To be added + + Sets the file referred to by as the + current file for the the file chooser. + a - a - To be added + a , true if both the folder + could be changed and the URI was + selected successfully, false otherwise. + + If the file name isn't in the current folder of the file chooser, + then the current folder of the file chooser will be changed to the folder containing + . This is equivalent to a sequence of + + followed by . + + Note that the file must exist, or nothing will be done except + for the directory change. To pre-enter a filename for the user, as in + a save-as dialog, use . + @@ -272,9 +356,9 @@ - To be added + The file chooser's current folder, if set from a URI. a - To be added + @@ -285,9 +369,9 @@ - To be added + An application-supplied widget to provide extra options to the user. a - To be added + @@ -297,9 +381,16 @@ System.String - To be added + + Property to represent the current name in the file selector, + as if entered by the user. + a - To be added + + Note that the name passed in here is a UTF-8 + string rather than a filename. This function is meant for + such uses as a suggested name in a "Save As..." dialog. + @@ -310,9 +401,9 @@ - To be added + The currently-applied file filter. a - To be added + @@ -323,9 +414,22 @@ - To be added + + Sets whether only local files can be selected in the + file selector. + a - To be added + + If true (the default), + then the selected file are files are guaranteed to be + accessible through the operating systems native file + file system and therefore the application only + needs to worry about the filename functions in + , like + , + rather than the URI functions like + . + @@ -336,9 +440,14 @@ - To be added + + Sets whether the preview widget set by + should be shown for the current filename. + a - To be added + When this property is set to false, the file chooser + may display an internally generated preview of the current file + or it may display no preview at all. @@ -349,9 +458,9 @@ - To be added + Internal function; gets the filename that should be previewed in a custom preview. a - To be added + Not for general programmer use. @@ -362,9 +471,15 @@ - To be added + The URI for the currently selected file in + the file selector. a - To be added + + If multiple files are selected, + one of the filenames will be returned at random. + If the file chooser is in folder mode, this function returns the + selected folder. + @@ -375,9 +490,16 @@ - To be added + + Sets whether the file chooser should display a stock label with the name of + the file that is being previewed; the default is true. + a - To be added + + Applications that + want to draw the whole preview area themselves should set this + to false and display the name themselves in their preview widget. + @@ -388,9 +510,9 @@ - To be added + The current filename selected by the file chooser. a - To be added + @@ -401,9 +523,9 @@ - To be added + The URI that should be previewed in a custom preview widget. a - To be added + @@ -414,9 +536,16 @@ - To be added + + Sets whether multiple files can be selected in the file selector. + a - To be added + + This is only relevant if the action is set to be + or + . + It cannot be set with either of the folder actions. + @@ -427,9 +556,32 @@ - To be added + + An application-supplied widget to use to display a custom preview + of the currently selected file. + a - To be added + + + To implement a preview, after setting the + preview widget, you connect to the + + signal, and check + or + + on each change. If you can + display a preview of the new file, update your widget and + set the preview active using + + Otherwise, set the preview inactive. + + + When there is no application-supplied preview widget, or the + application-supplied preview widget is not active, the file chooser + may display an internally generated preview of the current file or + it may display no preview at all. + + @@ -440,9 +592,17 @@ - To be added + + Sets the type of operation that that the chooser is performing; the + user interface is adapted to suit the selected action. + a - To be added + + For example, + an option to create a new folder might be shown if the action is + but not if the action is + . + @@ -453,9 +613,9 @@ - To be added + The current folder for the file chooser, when the chooser has selected a local filename. a - To be added + @@ -466,8 +626,9 @@ - To be added - To be added + This event is fired every time the selected file changes. + + @@ -478,8 +639,17 @@ - To be added - To be added + + This signal is emitted when the user "activates" a file in the file + chooser. + + + This event can happen by double-clicking on a file in the file list, or + by pressing Enter. + + Normally you do not need to connect to this signal. It is used internally + by the file chooser code to know when to activate the default button in the dialog. + @@ -490,8 +660,29 @@ - To be added - To be added + + This signal is emitted when the preview in a file chooser should be + regenerated. For example, this can happen when the currently + selected file changes. + + + You should use this signal if you want your file chooser to have + a preview widget. + + Once you have installed a preview widget with + , you should update it when this + signal is emitted. You can use the properties + or + + to get the name of the file to preview. + Your widget may not be able to preview all kinds of files; your callback + must set to inform the file + chooser about whether the preview was generated successfully or not. + + + TODO: insert example from gtkfilechooser-preview in gtk+ docs. + + @@ -502,9 +693,20 @@ - To be added - To be added + + This signal is emitted when the current folder in a file chooser + changes. + + + This event can happen due to the user performing some action that + changes folders, such as selecting a bookmark or visiting a folder on the + file list. It can also happen as a result of calling a function to + explicitly change the current folder in a file chooser. + + Normally you do not need to connect to this signal, unless you need to keep + track of which folder a file chooser is showing. + - \ No newline at end of file + diff --git a/doc/en/Gtk/FileChooserAction.xml b/doc/en/Gtk/FileChooserAction.xml index 4cf727bd4..610f3e8c1 100644 --- a/doc/en/Gtk/FileChooserAction.xml +++ b/doc/en/Gtk/FileChooserAction.xml @@ -38,7 +38,7 @@ Indicates open mode. The file chooser will only let the user pick an existing file. - To be added + @@ -51,7 +51,7 @@ Indicates save mode. The file chooser will let the user pick an existing file, or type in a new filename. - To be added + @@ -64,7 +64,7 @@ Indicates an Open mode for selecting folders. The file chooser will let the user pick an existing folder. - To be added + @@ -77,7 +77,7 @@ Indicates a mode for creating a new folder. The file chooser will let the user name an existing or new folder. - To be added + @@ -94,4 +94,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/FileChooserDefault.xml b/doc/en/Gtk/FileChooserDefault.xml index e181f16d7..1c8bf985b 100644 --- a/doc/en/Gtk/FileChooserDefault.xml +++ b/doc/en/Gtk/FileChooserDefault.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. To be added - To be added + Gtk.VBox @@ -43,7 +43,7 @@ To be added - To be added + @@ -59,7 +59,7 @@ To be added a a - To be added + @@ -71,7 +71,7 @@ To be added - To be added + @@ -87,7 +87,7 @@ To be added a a - To be added + @@ -103,7 +103,7 @@ To be added a a - To be added + @@ -119,7 +119,7 @@ To be added a a - To be added + @@ -131,7 +131,7 @@ To be added - To be added + @@ -147,7 +147,7 @@ To be added a a - To be added + @@ -162,7 +162,7 @@ To be added a - To be added + @@ -178,7 +178,7 @@ To be added a a - To be added + @@ -194,7 +194,7 @@ To be added a a - To be added + @@ -209,7 +209,7 @@ To be added a - To be added + @@ -224,7 +224,7 @@ To be added a - To be added + @@ -240,7 +240,7 @@ To be added a a - To be added + @@ -255,7 +255,7 @@ To be added a - To be added + @@ -271,7 +271,7 @@ To be added a a - To be added + @@ -287,7 +287,7 @@ To be added a a - To be added + @@ -361,7 +361,7 @@ To be added a a - To be added + @@ -375,7 +375,7 @@ To be added a a - To be added + @@ -386,7 +386,7 @@ To be added a - To be added + @@ -399,7 +399,7 @@ To be added a - To be added + @@ -412,7 +412,7 @@ To be added a - To be added + @@ -424,7 +424,7 @@ To be added a - To be added + @@ -437,7 +437,7 @@ To be added a - To be added + @@ -450,7 +450,7 @@ To be added a - To be added + @@ -463,7 +463,7 @@ To be added a - To be added + @@ -476,7 +476,7 @@ To be added a - To be added + @@ -489,7 +489,7 @@ To be added a - To be added + @@ -502,7 +502,7 @@ To be added a - To be added + @@ -515,7 +515,7 @@ To be added a - To be added + @@ -528,7 +528,7 @@ To be added a - To be added + @@ -541,7 +541,7 @@ To be added a - To be added + @@ -554,7 +554,7 @@ To be added a - To be added + @@ -567,7 +567,7 @@ To be added a - To be added + @@ -580,7 +580,7 @@ To be added a - To be added + @@ -592,7 +592,7 @@ To be added - To be added + @@ -604,7 +604,7 @@ To be added - To be added + @@ -616,7 +616,7 @@ To be added - To be added + @@ -628,7 +628,7 @@ To be added - To be added + @@ -640,8 +640,8 @@ To be added - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/FileChooserDialog.xml b/doc/en/Gtk/FileChooserDialog.xml index 0a545444f..3b58a1a0a 100644 --- a/doc/en/Gtk/FileChooserDialog.xml +++ b/doc/en/Gtk/FileChooserDialog.xml @@ -9,8 +9,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A dialog box for choosing files. + Gtk.Dialog @@ -39,8 +39,8 @@ - To be added - To be added + Override this method for operations that need to happen before object destruction. + @@ -56,7 +56,7 @@ To be added a a - To be added + @@ -68,7 +68,7 @@ To be added - To be added + @@ -84,7 +84,7 @@ To be added a a - To be added + @@ -100,7 +100,7 @@ To be added a a - To be added + @@ -116,7 +116,7 @@ To be added a a - To be added + @@ -128,7 +128,7 @@ To be added - To be added + @@ -144,7 +144,7 @@ To be added a a - To be added + @@ -159,7 +159,7 @@ To be added a - To be added + @@ -175,7 +175,7 @@ To be added a a - To be added + @@ -191,7 +191,7 @@ To be added a a - To be added + @@ -206,7 +206,7 @@ To be added a - To be added + @@ -221,7 +221,7 @@ To be added a - To be added + @@ -237,7 +237,7 @@ To be added a a - To be added + @@ -252,7 +252,7 @@ To be added a - To be added + @@ -268,7 +268,7 @@ To be added a a - To be added + @@ -284,7 +284,7 @@ To be added a a - To be added + @@ -346,7 +346,7 @@ To be added a a - To be added + @@ -360,7 +360,7 @@ To be added a a - To be added + @@ -378,7 +378,7 @@ a a a - To be added + @@ -392,13 +392,19 @@ - To be added + Makes a new file chooser dialog with a specific + file chooser backend a a a - a + a , the backend name a - To be added + + This is especially useful if you use + to allow + non-local files and you use a more expressive vfs, such as gnome-vfs, + to load files. + @@ -411,7 +417,7 @@ To be added a - To be added + @@ -424,7 +430,7 @@ To be added a - To be added + @@ -437,7 +443,7 @@ To be added a - To be added + @@ -449,7 +455,7 @@ To be added a - To be added + @@ -462,7 +468,7 @@ To be added a - To be added + @@ -475,7 +481,7 @@ To be added a - To be added + @@ -488,7 +494,7 @@ To be added a - To be added + @@ -501,7 +507,7 @@ To be added a - To be added + @@ -514,7 +520,7 @@ To be added a - To be added + @@ -527,7 +533,7 @@ To be added a - To be added + @@ -540,7 +546,7 @@ To be added a - To be added + @@ -553,7 +559,7 @@ To be added a - To be added + @@ -566,7 +572,7 @@ To be added a - To be added + @@ -579,7 +585,7 @@ To be added a - To be added + @@ -592,7 +598,7 @@ To be added a - To be added + @@ -605,7 +611,7 @@ To be added a - To be added + @@ -618,7 +624,7 @@ To be added a - To be added + @@ -631,7 +637,7 @@ To be added a - To be added + @@ -644,7 +650,7 @@ To be added a - To be added + @@ -657,7 +663,7 @@ To be added a - To be added + @@ -670,7 +676,7 @@ To be added a - To be added + @@ -682,7 +688,7 @@ To be added - To be added + @@ -694,7 +700,7 @@ To be added - To be added + @@ -706,7 +712,7 @@ To be added - To be added + @@ -718,8 +724,8 @@ To be added - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/FileChooserEmbed.xml b/doc/en/Gtk/FileChooserEmbed.xml index ac9307580..8cf39b9f4 100644 --- a/doc/en/Gtk/FileChooserEmbed.xml +++ b/doc/en/Gtk/FileChooserEmbed.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. To be added - To be added + @@ -29,8 +29,8 @@ To be added - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/FileChooserEntry.xml b/doc/en/Gtk/FileChooserEntry.xml index 6997b5402..b5e98a2d0 100644 --- a/doc/en/Gtk/FileChooserEntry.xml +++ b/doc/en/Gtk/FileChooserEntry.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. To be added - To be added + Gtk.Entry @@ -43,7 +43,7 @@ To be added - To be added + @@ -57,7 +57,7 @@ To be added a a - To be added + @@ -71,7 +71,7 @@ To be added a a - To be added + @@ -82,8 +82,8 @@ To be added a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/FileChooserError.xml b/doc/en/Gtk/FileChooserError.xml index 56b204e2f..807c3c4c0 100644 --- a/doc/en/Gtk/FileChooserError.xml +++ b/doc/en/Gtk/FileChooserError.xml @@ -38,7 +38,7 @@ Indicates that a file does not exist. - To be added + @@ -51,7 +51,7 @@ Indicates a malformed filename. - To be added + @@ -68,4 +68,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/FileChooserProp.xml b/doc/en/Gtk/FileChooserProp.xml index ba45e1a16..65f6b0f7b 100644 --- a/doc/en/Gtk/FileChooserProp.xml +++ b/doc/en/Gtk/FileChooserProp.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. To be added - To be added + System.Enum @@ -38,7 +38,7 @@ To be added - To be added + @@ -51,7 +51,7 @@ To be added - To be added + @@ -64,7 +64,7 @@ To be added - To be added + @@ -77,7 +77,7 @@ To be added - To be added + @@ -90,7 +90,7 @@ To be added - To be added + @@ -103,7 +103,7 @@ To be added - To be added + @@ -116,7 +116,7 @@ To be added - To be added + @@ -129,7 +129,7 @@ To be added - To be added + @@ -142,7 +142,7 @@ To be added - To be added + @@ -155,7 +155,7 @@ To be added - To be added + @@ -168,7 +168,7 @@ To be added - To be added + @@ -181,7 +181,7 @@ To be added - To be added + @@ -198,4 +198,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/FileChooserWidget.xml b/doc/en/Gtk/FileChooserWidget.xml index e5abd9a3b..422004530 100644 --- a/doc/en/Gtk/FileChooserWidget.xml +++ b/doc/en/Gtk/FileChooserWidget.xml @@ -10,7 +10,7 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. To be added - To be added + Gtk.VBox @@ -43,7 +43,7 @@ To be added - To be added + @@ -59,7 +59,7 @@ To be added a a - To be added + @@ -71,7 +71,7 @@ To be added - To be added + @@ -87,7 +87,7 @@ To be added a a - To be added + @@ -103,7 +103,7 @@ To be added a a - To be added + @@ -119,7 +119,7 @@ To be added a a - To be added + @@ -131,7 +131,7 @@ To be added - To be added + @@ -147,7 +147,7 @@ To be added a a - To be added + @@ -162,7 +162,7 @@ To be added a - To be added + @@ -178,7 +178,7 @@ To be added a a - To be added + @@ -194,7 +194,7 @@ To be added a a - To be added + @@ -209,7 +209,7 @@ To be added a - To be added + @@ -224,7 +224,7 @@ To be added a - To be added + @@ -240,7 +240,7 @@ To be added a a - To be added + @@ -255,7 +255,7 @@ To be added a - To be added + @@ -271,7 +271,7 @@ To be added a a - To be added + @@ -287,7 +287,7 @@ To be added a a - To be added + @@ -361,7 +361,7 @@ To be added a a - To be added + @@ -375,7 +375,7 @@ To be added a a - To be added + @@ -389,7 +389,7 @@ To be added a a - To be added + @@ -405,7 +405,7 @@ a a a - To be added + @@ -418,7 +418,7 @@ To be added a - To be added + @@ -431,7 +431,7 @@ To be added a - To be added + @@ -444,7 +444,7 @@ To be added a - To be added + @@ -456,7 +456,7 @@ To be added a - To be added + @@ -469,7 +469,7 @@ To be added a - To be added + @@ -482,7 +482,7 @@ To be added a - To be added + @@ -495,7 +495,7 @@ To be added a - To be added + @@ -508,7 +508,7 @@ To be added a - To be added + @@ -521,7 +521,7 @@ To be added a - To be added + @@ -534,7 +534,7 @@ To be added a - To be added + @@ -547,7 +547,7 @@ To be added a - To be added + @@ -560,7 +560,7 @@ To be added a - To be added + @@ -573,7 +573,7 @@ To be added a - To be added + @@ -586,7 +586,7 @@ To be added a - To be added + @@ -599,7 +599,7 @@ To be added a - To be added + @@ -612,7 +612,7 @@ To be added a - To be added + @@ -625,7 +625,7 @@ To be added a - To be added + @@ -638,7 +638,7 @@ To be added a - To be added + @@ -651,7 +651,7 @@ To be added a - To be added + @@ -664,7 +664,7 @@ To be added a - To be added + @@ -677,7 +677,7 @@ To be added a - To be added + @@ -689,7 +689,7 @@ To be added - To be added + @@ -701,7 +701,7 @@ To be added - To be added + @@ -713,7 +713,7 @@ To be added - To be added + @@ -725,7 +725,7 @@ To be added - To be added + @@ -737,8 +737,8 @@ To be added - To be added + - \ No newline at end of file +