Difference between revisions of "Mac OS X Porting - Proxy Icon implementation"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Description: what is a "proxy icon ?)
Line 14: Line 14:
 
<br>
 
<br>
 
[[Image:Aqua_proxy_icon.jpg]]
 
[[Image:Aqua_proxy_icon.jpg]]
 +
 +
 +
<br>Here is what it looks like in e. g. TextEdit
 +
<br>without proxy icon:
 +
<br>[[Image:TextEdit_noIcon.png]]
 +
<br>
 +
<br>with proxy icon:
 +
<br>[[Image:TextEdit_withIcon.png]]
 +
  
 
== Goal ==
 
== Goal ==

Revision as of 21:40, 2 September 2008

Description: what is a "proxy icon ?



The little icon on the top border of the window :

Aqua proxy icon top window.jpg





The great idea, is to use this icon ( using CMD + clic on it) for drag and drop and other goodies, as shown on the image below :


Aqua proxy icon.jpg



Here is what it looks like in e. g. TextEdit
without proxy icon:
TextEdit noIcon.png

with proxy icon:
TextEdit withIcon.png


Goal

Implement the feature "proxy icon", in OpenOffice.org Aqua, on Mac OS X

Timeline

Expected timeline: October / November 2008

The plan

The new feature will be in the proxyicon4mac cws

Concerned domains


Build :
  • item 1
  • item 2
  • complete me


Core :
  • item 1
  • item 2

...

User Interface :
  • item 1
  • item 2
  • complete me

Current status

After, just a quick look, the concerned code could be in vcl/aqua/source/window/salframe.cxx :

First idea: create AquaSalFrame::SetProxyIcon (WindowRef inWindow, FSRef * outRef )

We immediately see what we need is the path ( FSRef ) of the concerned file contained in the window, and the pointer on the Window (not a problem)

Other need: check whether the window is a document or not (help, preferences, dialog box .. and so on).

-> ask dev@ or dev@framework for the info

Maybe check whether void AquaSalFrame::SetIcon( USHORT nIcon ) or maybe void AquaSalFrame::SetTitle(const XubString& rTitle) can help

Probable algorithm :

  • Test if the Window is a document (not help or print or dialog box window) ?
    • No : do nothing
    • Yes: ( is a document ):
  • Has the document been already saved ?
    • never saved => do nothing
    • else => set the proxy icon (and not set the title probably)


The probable right function to use is (copied from XCode documentation) :

HIWindowGetProxyFSRef Obtains the FSRef used to determine the proxy icon for a window.

OSStatus HIWindowGetProxyFSRef (
  WindowRef inWindow,
  FSRef * outRef
);

Parameters inWindow The window whose proxy FSRef is to be obtained.

outRef On exit, the FSRef for the window’s proxy icon.

Return Value A result code. See “Window Manager Result Codes”.

Discussion If the specified window’s proxy icon has been specified using HIWindowSetProxyFSRef or SetWindowProxyAlias, HIWindowGetProxyFSRef returns noErr and a valid FSRef for the window’s proxy icon. If the window has no proxy icon, or if the icon was specified by calling SetWindowProxyCreatorAndType or SetWindowProxyIcon, this function returns an error.

Availability Available in Mac OS X v10.4 and later. Declared In MacWindows.h

Other usefull stuff: in the Aqua File Picker Florian Heckl wrote, are a lot of usefull methods, and we could reuse them, mainly to find a path but not only




static OSStatus setWindowTitleAndProxyFromFSRef( WindowRef window, FSRef *fileRef )
{
    OSStatus err = noErr;
  HFSUniStr255 name;
  CFStringRef fileName = NULL;
  
  err = FSGetCatalogInfo( fileRef, 0, NULL, &name, NULL, NULL );
    require_noerr( err, CantGetInfo );
  
  fileName = CFStringCreateWithCharacters( kCFAllocatorDefault, name.unicode, name.length );
  SetWindowTitleWithCFString( window, fileName );
  HIWindowSetProxyFSRef( window, fileRef );
  SetWindowModified( window, false );

CantGetInfo:
  if( fileName )
    CFRelease( fileName );
  return err;
}

Links (to be improved):

Handling Carbon Windows and Controls: Basic Window Manipulation: Adding Window Proxy Icons

Sample code (Carbon, can be obsolete)

Proxy Icon search on Apple lists

Google search of apple.com for alternative expressions "title bar proxy" or "titlebar proxy"

Apple Human Interface Guidelines: Window Elements "A standard document window may also have … A proxy icon (after a document has been saved)…"


Ericb 13:03, 30 August 2008 (CEST) 

Personal tools