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 :: ui :: dialogs ::

interface XFilterManager
Description
Specifies a filter manager interface for a FilePicker

Methods' Summary
appendFilter Adds a filter identified by a title.  
setCurrentFilter Sets the current filter.  
getCurrentFilter Returns the currently selected filter.  
Methods' Details
appendFilter
void
appendFilter( [in] string  aTitle,
[in] string  aFilter )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Adds a filter identified by a title.
Parameter aTitle
Specifies the name of the filter as shown in the filter box of the FilePicker dialog.
Parameter aFilter
Specifies the extensions of the filter. Multiple filters should be semicolon separated. The semicolon may not be used as character in a filter expresion. A typical filter is for instance '*.txt'.
Throws
::com::sun::star::lang::IllegalArgumentException If a filter with the specified title already exists.
setCurrentFilter
void
setCurrentFilter( [in] string  aTitle )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
Sets the current filter.
Parameter aTitle
Specifies the name of the filter to be set.
Throws
com::sun::star::lang::IllegalArgumentException If the specified filter was not found.
getCurrentFilter
string
getCurrentFilter();

Description
Returns the currently selected filter.
Returns
The name of the selected filter or an empty string if there is no filter or no filter is currently selected.
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.