#include <glibmm/main.h>
#include <glibmm/refptr.h>
#include <glibmm/ustring.h>
-#include <glib/gtypes.h>
+#include <glib.h>
#include <string>
#include <glibmmconfig.h>
#endif /* defined(G_OS_WIN32) || defined(DOXYGEN_SHOULD_SKIP_THIS) */
/** Read a single UCS-4 character.
- * @retval unichar The Unicode character.
+ * @retval thechar The Unicode character.
* @return The status of the operation.
* @throw Glib::IOChannelError
* @throw Glib::ConvertError
*/
- /** This function cannot be called on a channel with <tt>0</tt> encoding.
+ /** Reads a Unicode character from @a channel.
+ * This function cannot be called on a channel with <tt>0</tt> encoding.
* @param thechar A location to return a character.
- * @param error A location to return an error of type G::ConvertError
- * or G::IOChannelError.
- * @return A G::IOStatus.
+ * @return A IOStatus.
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
- IOStatus read(gunichar& unichar);
+ IOStatus read(gunichar& thechar);
#else
- IOStatus read(gunichar& unichar, std::auto_ptr<Glib::Error>& error);
+ IOStatus read(gunichar& thechar, std::auto_ptr<Glib::Error>& error);
#endif //GLIBMM_EXCEPTIONS_ENABLED
* success if count < 6 and the channel's encoding is non-<tt>0</tt>.
* This indicates that the next UTF-8 character is too wide for
* the buffer.
- * @param error A location to return an error of type G::ConvertError
- * or G::IOChannelError.
* @return The status of the operation.
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
* @param count The size of the buffer. If -1, the buffer
* is taken to be a nul-terminated string.
* @param bytes_written The number of bytes written. This can be nonzero
- * even if the return value is not G::IO_STATUS_NORMAL.
- * If the return value is G::IO_STATUS_NORMAL and the
+ * even if the return value is not IO_STATUS_NORMAL.
+ * If the return value is IO_STATUS_NORMAL and the
* channel is blocking, this will always be equal
- * to @a count if @a count >= 0.
- * @param error A location to return an error of type G::ConvertError
- * or G::IOChannelError.
+ * to @a count if @a count >= 0.
* @return The status of the operation.
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
* @throw Glib::ConvertError
*/
- /** This function cannot be called on a channel with <tt>0</tt> encoding.
+ /** Writes a Unicode character to @a channel.
+ * This function cannot be called on a channel with <tt>0</tt> encoding.
* @param thechar A character.
- * @param error A location to return an error of type G::ConvertError
- * or G::IOChannelError.
- * @return A G::IOStatus.
+ * @return A IOStatus.
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
IOStatus write(gunichar unichar);
*/
/** Replacement for g_io_channel_seek() with the new API.
- * @param offset The offset in bytes from the position specified by @a type .
- * @param type A G::SeekType. The type G::SEEK_CUR is only allowed in those
+ * @param offset The offset in bytes from the position specified by @a type.
+ * @param type A SeekType. The type SEEK_CUR is only allowed in those
* cases where a call to g_io_channel_set_encoding()
* is allowed. See the documentation for
* g_io_channel_set_encoding() for details.
- * @param error A location to return an error of type G::IOChannelError.
* @return The status of the operation.
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
*/
/** Flushes the write buffer for the GIOChannel.
- * @param error Location to store an error of type G::IOChannelError.
* @return The status of the operation: One of
- * G::IO_CHANNEL_NORMAL, G::IO_CHANNEL_AGAIN, or
- * G::IO_CHANNEL_ERROR.
+ * IO_CHANNEL_NORMAL, IO_CHANNEL_AGAIN, or
+ * IO_CHANNEL_ERROR.
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
IOStatus flush();
*/
/** Close an IO channel. Any pending data to be written will be
- * flushed if @a flush is <tt>true</tt>. The channel will not be freed until the
+ * flushed if @a flush is <tt>true</tt>. The channel will not be freed until the
* last reference is dropped using g_io_channel_unref().
* @param flush If <tt>true</tt>, flush pending.
- * @param err Location to store a G::IOChannelError.
+ * @param err Location to store a IOChannelError.
* @return The status of the operation.
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
*/
/** Sets the buffer size.
- * @param size The size of the buffer. 0 == pick a good size.
+ * @param size The size of the buffer, or 0 to let GLib pick a good size.
*/
void set_buffer_size(gsize size);
* @return Bitwise combination of the flags set on the channel.
*/
- /** Gets the current flags for a G::IOChannel, including read-only
- * flags such as G::IO_FLAG_IS_READABLE.
+ /** Gets the current flags for a IOChannel, including read-only
+ * flags such as IO_FLAG_IS_READABLE.
*
- * The values of the flags G::IO_FLAG_IS_READABLE and G::IO_FLAG_IS_WRITEABLE
+ * The values of the flags IO_FLAG_IS_READABLE and IO_FLAG_IS_WRITEABLE
* are cached for internal use by the channel when it is created.
* If they should change at some later point (e.g. partial shutdown
* of a socket with the UNIX shutdown() function), the user
* @throw Glib::IOChannelError
*/
- /** Sets the (writeable) flags in @a channel to ( @a flags & G::IO_CHANNEL_SET_MASK).
+ /** Sets the (writeable) flags in @a channel to ( @a flags & IO_CHANNEL_SET_MASK).
* @param flags The flags to set on the IO channel.
- * @param error A location to return an error of type G::IOChannelError.
* @return The status of the operation.
*/
#ifdef GLIBMM_EXCEPTIONS_ENABLED
*
* A buffered channel can only be set unbuffered if the channel's
* internal buffers have been flushed. Newly created channels or
- * channels which have returned G::IO_STATUS_EOF
+ * channels which have returned IO_STATUS_EOF
* not require such a flush. For write-only channels, a call to
* g_io_channel_flush() is sufficient. For all other channels,
* the buffers may be flushed by a call to g_io_channel_seek_position().
- * This includes the possibility of seeking with seek type G::SEEK_CUR
+ * This includes the possibility of seeking with seek type SEEK_CUR
* and an offset of zero. Note that this means that socket-based
* channels cannot be set unbuffered once they have had data
* read from them.
* @return The buffering status of the channel.
*/
- /** Returns whether @a channel is buffered.
- * @return <tt>true</tt> if the @a channel is buffered.
+ /** Return Value: <tt>true</tt> if the @a channel is buffered.
+ * @return <tt>true</tt> if the @a channel is buffered.
*/
bool get_buffered() const;
* @return Bitwise combination of Glib::IOCondition flags.
*/
- /** This function returns a G::IOCondition depending on whether there
- * is data to be read/space to write data in the
- * internal buffers in the G::IOChannel. Only the flags G::IO_IN and
- * G::IO_OUT may be set.
- * @return A G::IOCondition.
+ /** This function returns a IOCondition depending on whether there
+ * is data to be read/space to write data in the internal buffers in
+ * the IOChannel. Only the flags IO_IN and IO_OUT may be set.
+ * @return A IOCondition.
*/
IOCondition get_buffer_condition() const;
* IOChannel object.
*/
- /** Returns whether the file/socket/whatever associated with @a channel
- * will be closed when @a channel receives its final unref and is
- * destroyed. The default value of this is <tt>true</tt> for channels created
- * by g_io_channel_new_file(), and <tt>false</tt> for all other channels.
+ /** Return value: Whether the channel will be closed on the final unref of
* @return Whether the channel will be closed on the final unref of
* the GIOChannel data structure.
*/
projects / ardour.git / blobdiff