Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: ucb ::

service FileContent
Description
A File Content represents either a directory or a file in the local file system.

Whether a content represents a folder or a file can be determined by inspecting its property IsFolder or IsDocument.

See also
FileContentProvider

Exported Interfaces - Summary
::com::sun::star::lang::XComponent

This interface is implemented according to the specification of service Content.

XContent

This interface is implemented according to the specification of service Content.

XContentCreator

This interface is implemented according to the specification of service Content. (details)

XCommandProcessor

This interface is implemented according to the specification of service Content. (details)

XCommandProcessor2

is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via XCommandProcessor::createCommandIdentifier to avoid resource leaks. For a detailed description of the problem refer to XCommandProcessor2::releaseCommandIdentifier. (details)

::com::sun::star::beans::XPropertiesChangeNotifier

This interface is implemented according to the specification of service Content.

::com::sun::star::beans::XPropertyContainer

This interface is implemented according to the specification of service Content.

::com::sun::star::beans::XPropertySetInfoChangeNotifier

This interface is implemented according to the specification of service Content.

XCommandInfoChangeNotifier

This interface is implemented according to the specification of service Content.

::com::sun::star::container::XChild

This interface is implemented according to the specification of service Content.

Exported Interfaces - Details
::com::sun::star::lang::XComponent
Description
This interface is implemented according to the specification of service Content.
XContent
Description
This interface is implemented according to the specification of service Content.
XContentCreator
Description
This interface is implemented according to the specification of service Content.

An object representing a directory in the file system is able to create a new object, which in turn can become the representation of a physical file/directory being contained in the initial directory. The precise way is the following:

  1. Let the parent folder create a new content by calling XContentCreator::createNewContent on it. The content type to use for new directories is "application/vnd.sun.staroffice.fsys-folder". To create a new file use the type "application/vnd.sun.staroffice.fsys-file". As return value you get a new file content object.
  2. Set a title at the new object by letting it execute the command "setPropertyValues", which sets at least the property "Title" to a non-empty value ).
  3. Let the new object ( not the parent! ) execute the command "insert". This will create the corresponding physical file or directory. For files, you need to supply the implementation of an ::com::sun::star::io::XInputStream with the command's parameters, that provides access to the stream data.

XCommandProcessor
Description
This interface is implemented according to the specification of service Content.

Supported Commands

  • getCommandInfo
  • getPropertySetInfo
  • getPropertyValues
  • setPropertyValues
  • insert ( makes a newly created document persistent )
  • delete
  • open
  • transfer
Supported Properties
  • string ContentType ( read-only, either "application/vnd.sun.staroffice.fsys-folder" or "application/vnd.sun.staroffice.fsys-file" )
  • boolean IsDocument ( read-only, always true for files, always false for directories )
  • boolean IsFolder ( read-only ), always false for files, always true for directories )
  • ::com::sun::star::util::DateTime DateModified ( read-only )
  • boolean IsReadOnly ( read-only attribute )
  • hyper Size ( file size )
  • string Title ( file name )
  • boolean IsVolume ( read-only )
  • boolean IsRemoveable ( read-only )
  • boolean IsRemote ( read-only )
  • boolean IsCompactDisc ( read-only )
  • boolean IsFloppy ( read-only )
  • boolean IsHidden ( read-only )

XCommandProcessor2
Usage Restrictions
optional
Description
is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via XCommandProcessor::createCommandIdentifier to avoid resource leaks. For a detailed description of the problem refer to XCommandProcessor2::releaseCommandIdentifier.

Where many existing Content implementations do not (yet), every new implementation should support this interface.

::com::sun::star::beans::XPropertiesChangeNotifier
Description
This interface is implemented according to the specification of service Content.
::com::sun::star::beans::XPropertyContainer
Description
This interface is implemented according to the specification of service Content.
::com::sun::star::beans::XPropertySetInfoChangeNotifier
Description
This interface is implemented according to the specification of service Content.
XCommandInfoChangeNotifier
Description
This interface is implemented according to the specification of service Content.
::com::sun::star::container::XChild
Description
This interface is implemented according to the specification of service Content.

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.